@aws-cdk/aws-ec2

AWS Compute and Networking Construct Library

The @aws-cdk/aws-ec2 package contains primitives for setting up networking and instances.

VPC

Most projects need a Virtual Private Cloud to provide security by means of network partitioning. This is easily achieved by creating an instance of VpcNetwork:

import ec2 = require('@aws-cdk/aws-ec2');

const vpc = new ec2.VpcNetwork(this, 'VPC');

All default Constructs requires EC2 instances to be launched inside a VPC, so you should generally start by defining a VPC whenever you need to launch instances for your project.

Our default VpcNetwork class creates a private and public subnet for every availability zone. Classes that use the VPC will generally launch instances into all private subnets, and provide a parameter called vpcPlacement to allow you to override the placement. Read more about subnets.

Advanced Subnet Configuration

If you require the ability to configure subnets the VpcNetwork can be customized with SubnetConfiguration array. This is best explained by an example:

import ec2 = require('@aws-cdk/aws-ec2');

const vpc = new ec2.VpcNetwork(stack, 'TheVPC', {
  cidr: '10.0.0.0/21',
  subnetConfiguration: [
    {
      cidrMask: 24,
      name: 'Ingress',
      subnetType: SubnetType.Public,
    },
    {
      cidrMask: 24,
      name: 'Application',
      subnetType: SubnetType.Private,
    },
    {
      cidrMask: 28,
      name: 'Database',
      subnetType: SubnetType.Isolated,
    }
  ],
});

The example above is one possible configuration, but the user can use the constructs above to implement many other network configurations.

The VpcNetwork from the above configuration in a Region with three availability zones will be the following:

  • IngressSubnet1: 10.0.0.0/24
  • IngressSubnet2: 10.0.1.0/24
  • IngressSubnet3: 10.0.2.0/24
  • ApplicationSubnet1: 10.0.3.0/24
  • ApplicationSubnet2: 10.0.4.0/24
  • ApplicationSubnet3: 10.0.5.0/24
  • DatabaseSubnet1: 10.0.6.0/28
  • DatabaseSubnet2: 10.0.6.16/28
  • DatabaseSubnet3: 10.0.6.32/28

Each Public Subnet will have a NAT Gateway. Each Private Subnet will have a route to the NAT Gateway in the same availability zone. Each Isolated subnet will not have a route to the internet, but is routeable inside the VPC. The numbers [1-3] will consistently map to availability zones (e.g. IngressSubnet1 and ApplicationSubnet1 will be in the same avialbility zone).

Isolated Subnets provide simplified secure networking principles, but come at an operational complexity. The lack of an internet route means that if you deploy instances in this subnet you will not be able to patch from the internet, this is commonly reffered to as fully baked images. Features such as cfn-signal are also unavailable. Using these subnets for managed services (RDS, Elasticache, Redshift) is a very practical use because the managed services do not incur additional operational overhead.

Many times when you plan to build an application you don’t know how many instances of the application you will need and therefore you don’t know how much IP space to allocate. For example, you know the application will only have Elastic Loadbalancers in the public subnets and you know you will have 1-3 RDS databases for your data tier, and the rest of the IP space should just be evenly distributed for the application.

import ec2 = require('@aws-cdk/aws-ec2');

const vpc = new ec2.VpcNetwork(stack, 'TheVPC', {
  cidr: '10.0.0.0/16',
  natGateways: 1,
  subnetConfiguration: [
    {
      cidrMask: 26,
      name: 'Public',
      subnetType: SubnetType.Public,
    },
    {
      name: 'Application',
      subnetType: SubnetType.Private,
    },
    {
      cidrMask: 27,
      name: 'Database',
      subnetType: SubnetType.Isolated,
    }
  ],
});

The VpcNetwork from the above configuration in a Region with three availability zones will be the following:

  • PublicSubnet1: 10.0.0.0/26
  • PublicSubnet2: 10.0.0.64/26
  • PublicSubnet3: 10.0.2.128/26
  • DatabaseSubnet1: 10.0.0.192/27
  • DatabaseSubnet2: 10.0.0.224/27
  • DatabaseSubnet3: 10.0.1.0/27
  • ApplicationSubnet1: 10.0.64.0/18
  • ApplicationSubnet2: 10.0.128.0/18
  • ApplicationSubnet3: 10.0.192.0/18

Any subnet configuration without a cidrMask will be counted up and allocated evenly across the remaining IP space.

Teams may also become cost conscious and be willing to trade availability for cost. For example, in your test environments perhaps you would like the same VPC as production, but instead of 3 NAT Gateways you would like only 1. This will save on the cost, but trade the 3 availability zone to a 1 for all egress traffic. This can be accomplished with a single parameter configuration:

import ec2 = require('@aws-cdk/aws-ec2');

const vpc = new ec2.VpcNetwork(stack, 'TheVPC', {
  cidr: '10.0.0.0/16',
  natGateways: 1,
  natGatewayPlacement: {subnetName: 'Public'},
  subnetConfiguration: [
    {
      cidrMask: 26,
      name: 'Public',
      subnetType: SubnetType.Public,
      natGateway: true,
    },
    {
      name: 'Application',
      subnetType: SubnetType.Private,
    },
    {
      cidrMask: 27,
      name: 'Database',
      subnetType: SubnetType.Isolated,
    }
  ],
});

The VpcNetwork above will have the exact same subnet definitions as listed above. However, this time the VPC will have only 1 NAT Gateway and all Application subnets will route to the NAT Gateway.

Allowing Connections

In AWS, all network traffic in and out of Elastic Network Interfaces (ENIs) is controlled by Security Groups. You can think of Security Groups as a firewall with a set of rules. By default, Security Groups allow no incoming (ingress) traffic and all outgoing (egress) traffic. You can add ingress rules to them to allow incoming traffic streams. To exert fine-grained control over egress traffic, set allowAllOutbound: false on the SecurityGroup, after which you can add egress traffic rules.

You can manipulate Security Groups directly:

const mySecurityGroup = new ec2.SecurityGroup(this, 'SecurityGroup', {
  vpc,
  description: 'Allow ssh access to ec2 instances',
  allowAllOutbound: true   // Can be set to false
});
mySecurityGroup.addIngressRule(new ec2.AnyIPv4(), new ec2.TcpPort(22), 'allow ssh access from the world');

All constructs that create ENIs on your behalf (typically constructs that create EC2 instances or other VPC-connected resources) will all have security groups automatically assigned. Those constructs have an attribute called connections, which is an object that makes it convenient to update the security groups. If you want to allow connections between two constructs that have security groups, you have to add an Egress* rule to one Security Group, and an **Ingress rule to the other. The connections object will automatically take care of this for you:

// Allow connections from anywhere
loadBalancer.connections.allowFromAnyIpv4(new ec2.TcpPort(443), 'Allow inbound HTTPS');

// The same, but an explicit IP address
loadBalancer.connections.allowFrom(new ec2.CidrIpv4('1.2.3.4/32'), new ec2.TcpPort(443), 'Allow inbound HTTPS');

// Allow connection between AutoScalingGroups
appFleet.connections.allowTo(dbFleet, new ec2.TcpPort(443), 'App can call database');

Connection Peers

There are various classes that implement the connection peer part:

// Simple connection peers
let peer = new ec2.CidrIp("10.0.0.0/16");
let peer = new ec2.AnyIPv4();
let peer = new ec2.CidrIpv6("::0/0");
let peer = new ec2.AnyIPv6();
let peer = new ec2.PrefixList("pl-12345");
fleet.connections.allowTo(peer, new ec2.TcpPort(443), 'Allow outbound HTTPS');

Any object that has a security group can itself be used as a connection peer:

// These automatically create appropriate ingress and egress rules in both security groups
fleet1.connections.allowTo(fleet2, new ec2.TcpPort(80), 'Allow between fleets');

fleet.connections.allowTcpPort(80), 'Allow from load balancer');

Port Ranges

The connections that are allowed are specified by port ranges. A number of classes provide the connection specifier:

new ec2.TcpPort(80)
new ec2.TcpPortRange(60000, 65535)
new ec2.TcpAllPorts()
new ec2.AllConnections()
NOTE: This set is not complete yet; for example, there is no library support for ICMP at the moment. However, you can write your own classes to implement those.

Default Ports

Some Constructs have default ports associated with them. For example, the listener of a load balancer does (it’s the public port), or instances of an RDS database (it’s the port the database is accepting connections on).

If the object you’re calling the peering method on has a default port associated with it, you can call allowDefaultPortFrom() and omit the port specifier. If the argument has an associated default port, call allowToDefaultPort().

For example:

// Port implicit in listener
listener.connections.allowDefaultPortFromAnyIpv4('Allow public');

// Port implicit in peer
fleet.connections.allowToDefaultPort(rdsDatabase, 'Fleet can access database');

Reference

View in Nuget

csproj:

<PackageReference Include="Amazon.CDK.AWS.EC2" Version="0.14.1" />

dotnet:

dotnet add package Amazon.CDK.AWS.EC2 --version 0.14.1

packages.config:

<package id="Amazon.CDK.AWS.EC2" version="0.14.1" />

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:ec2:jar:0.14.1'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="ec2" rev="0.14.1"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>ec2</artifactId>
  <version>0.14.1</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:ec2:0.14.1'

Groovy Grape:

@Grapes(
@Grab(group='software.amazon.awscdk', module='ec2', version='0.14.1')
)

View in NPM

npm:

$ npm i @aws-cdk/aws-ec2@0.14.1

package.json:

{
  "@aws-cdk/aws-ec2": "^0.14.1"
}

yarn:

$ yarn add @aws-cdk/aws-ec2@0.14.1

View in NPM

npm:

$ npm i @aws-cdk/aws-ec2@0.14.1

package.json:

{
  "@aws-cdk/aws-ec2": "^0.14.1"
}

yarn:

$ yarn add @aws-cdk/aws-ec2@0.14.1

AllTraffic

class @aws-cdk/aws-ec2.AllTraffic

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AllTraffic;
const { AllTraffic } = require('@aws-cdk/aws-ec2');
import { AllTraffic } from '@aws-cdk/aws-ec2';

All Traffic

Implements:IPortRange
toRuleJSON() → any

Implements @aws-cdk/aws-ec2.IPortRange.toRuleJSON()

Produce the ingress/egress rule JSON for the given connection

Return type:any or undefined
toString() → string

Returns a string representation of an object.

Return type:string
canInlineRule

Implements @aws-cdk/aws-ec2.IPortRange.canInlineRule()

Whether the rule containing this port range can be inlined into a securitygroup or not.

Type:boolean (readonly)

AmazonLinuxEdition (enum)

class @aws-cdk/aws-ec2.AmazonLinuxEdition

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AmazonLinuxEdition;
const { AmazonLinuxEdition } = require('@aws-cdk/aws-ec2');
import { AmazonLinuxEdition } from '@aws-cdk/aws-ec2';

Amazon Linux edition

Standard

Standard edition

Minimal

Minimal edition

AmazonLinuxImage

class @aws-cdk/aws-ec2.AmazonLinuxImage([props])

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AmazonLinuxImage;
const { AmazonLinuxImage } = require('@aws-cdk/aws-ec2');
import { AmazonLinuxImage } from '@aws-cdk/aws-ec2';

Selects the latest version of Amazon Linux The AMI ID is selected using the values published to the SSM parameter store.

Implements:IMachineImageSource
Parameters:props (AmazonLinuxImageProps or undefined) –
getImage(parent) → @aws-cdk/aws-ec2.MachineImage

Implements @aws-cdk/aws-ec2.IMachineImageSource.getImage()

Return the image to use in the given context

Parameters:parent (@aws-cdk/cdk.Construct) –
Return type:MachineImage

AmazonLinuxImageProps (interface)

class @aws-cdk/aws-ec2.AmazonLinuxImageProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AmazonLinuxImageProps;
// AmazonLinuxImageProps is an interface
import { AmazonLinuxImageProps } from '@aws-cdk/aws-ec2';

Amazon Linux image properties

edition

What edition of Amazon Linux to use

Type:AmazonLinuxEdition or undefined (abstract)
storage

What storage backed image to use

Type:AmazonLinuxStorage or undefined (abstract)
virtualization

Virtualization type

Type:AmazonLinuxVirt or undefined (abstract)

AmazonLinuxStorage (enum)

class @aws-cdk/aws-ec2.AmazonLinuxStorage

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AmazonLinuxStorage;
const { AmazonLinuxStorage } = require('@aws-cdk/aws-ec2');
import { AmazonLinuxStorage } from '@aws-cdk/aws-ec2';
EBS

EBS-backed storage

GeneralPurpose

General Purpose-based storage (recommended)

AmazonLinuxVirt (enum)

class @aws-cdk/aws-ec2.AmazonLinuxVirt

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AmazonLinuxVirt;
const { AmazonLinuxVirt } = require('@aws-cdk/aws-ec2');
import { AmazonLinuxVirt } from '@aws-cdk/aws-ec2';

Virtualization type for Amazon Linux

HVM

HVM virtualization (recommended)

PV

PV virtualization

AnyIPv4

class @aws-cdk/aws-ec2.AnyIPv4

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AnyIPv4;
const { AnyIPv4 } = require('@aws-cdk/aws-ec2');
import { AnyIPv4 } from '@aws-cdk/aws-ec2';

Any IPv4 address

Extends:CidrIPv4
toEgressRuleJSON() → any

Inherited from @aws-cdk/aws-ec2.CidrIPv4

Produce the egress rule JSON for the given connection

Return type:any or undefined
toIngressRuleJSON() → any

Inherited from @aws-cdk/aws-ec2.CidrIPv4

Produce the ingress rule JSON for the given connection

Return type:any or undefined
canInlineRule

Inherited from @aws-cdk/aws-ec2.CidrIPv4

Whether the rule can be inlined into a SecurityGroup or not

Type:boolean (readonly)
cidrIp

Inherited from @aws-cdk/aws-ec2.CidrIPv4

Type:string (readonly)
connections

Inherited from @aws-cdk/aws-ec2.CidrIPv4

Type:Connections (readonly)
uniqueId

Inherited from @aws-cdk/aws-ec2.CidrIPv4

A unique identifier for this connection peer

Type:string (readonly)

AnyIPv6

class @aws-cdk/aws-ec2.AnyIPv6

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AnyIPv6;
const { AnyIPv6 } = require('@aws-cdk/aws-ec2');
import { AnyIPv6 } from '@aws-cdk/aws-ec2';

Any IPv6 address

Extends:CidrIPv6
toEgressRuleJSON() → any

Inherited from @aws-cdk/aws-ec2.CidrIPv6

Produce the egress rule JSON for the given connection

Return type:any or undefined
toIngressRuleJSON() → any

Inherited from @aws-cdk/aws-ec2.CidrIPv6

Produce the ingress rule JSON for the given connection

Return type:any or undefined
canInlineRule

Inherited from @aws-cdk/aws-ec2.CidrIPv6

Whether the rule can be inlined into a SecurityGroup or not

Type:boolean (readonly)
cidrIpv6

Inherited from @aws-cdk/aws-ec2.CidrIPv6

Type:string (readonly)
connections

Inherited from @aws-cdk/aws-ec2.CidrIPv6

Type:Connections (readonly)
uniqueId

Inherited from @aws-cdk/aws-ec2.CidrIPv6

A unique identifier for this connection peer

Type:string (readonly)

CidrIPv4

class @aws-cdk/aws-ec2.CidrIPv4(cidrIp)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CidrIPv4;
const { CidrIPv4 } = require('@aws-cdk/aws-ec2');
import { CidrIPv4 } from '@aws-cdk/aws-ec2';

A connection to and from a given IP range

Implements:ISecurityGroupRule
Implements:IConnectable
Parameters:cidrIp (string) –
toEgressRuleJSON() → any

Implements @aws-cdk/aws-ec2.ISecurityGroupRule.toEgressRuleJSON()

Produce the egress rule JSON for the given connection

Return type:any or undefined
toIngressRuleJSON() → any

Implements @aws-cdk/aws-ec2.ISecurityGroupRule.toIngressRuleJSON()

Produce the ingress rule JSON for the given connection

Return type:any or undefined
canInlineRule

Implements @aws-cdk/aws-ec2.ISecurityGroupRule.canInlineRule()

Whether the rule can be inlined into a SecurityGroup or not

Type:boolean (readonly)
cidrIp
Type:string (readonly)
connections

Implements @aws-cdk/aws-ec2.IConnectable.connections()

Type:Connections (readonly)
uniqueId

Implements @aws-cdk/aws-ec2.ISecurityGroupRule.uniqueId()

A unique identifier for this connection peer

Type:string (readonly)

CidrIPv6

class @aws-cdk/aws-ec2.CidrIPv6(cidrIpv6)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CidrIPv6;
const { CidrIPv6 } = require('@aws-cdk/aws-ec2');
import { CidrIPv6 } from '@aws-cdk/aws-ec2';

A connection to a from a given IPv6 range

Implements:ISecurityGroupRule
Implements:IConnectable
Parameters:cidrIpv6 (string) –
toEgressRuleJSON() → any

Implements @aws-cdk/aws-ec2.ISecurityGroupRule.toEgressRuleJSON()

Produce the egress rule JSON for the given connection

Return type:any or undefined
toIngressRuleJSON() → any

Implements @aws-cdk/aws-ec2.ISecurityGroupRule.toIngressRuleJSON()

Produce the ingress rule JSON for the given connection

Return type:any or undefined
canInlineRule

Implements @aws-cdk/aws-ec2.ISecurityGroupRule.canInlineRule()

Whether the rule can be inlined into a SecurityGroup or not

Type:boolean (readonly)
cidrIpv6
Type:string (readonly)
connections

Implements @aws-cdk/aws-ec2.IConnectable.connections()

Type:Connections (readonly)
uniqueId

Implements @aws-cdk/aws-ec2.ISecurityGroupRule.uniqueId()

A unique identifier for this connection peer

Type:string (readonly)

ConnectionRule (interface)

class @aws-cdk/aws-ec2.ConnectionRule

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.ConnectionRule;
// ConnectionRule is an interface
import { ConnectionRule } from '@aws-cdk/aws-ec2';
fromPort

Start of port range for the TCP and UDP protocols, or an ICMP type number. If you specify icmp for the IpProtocol property, you can specify -1 as a wildcard (i.e., any ICMP type number).

Type:number (abstract)
description

Description of this connection. It is applied to both the ingress rule and the egress rule.

Type:string or undefined (abstract)
protocol

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all protocols. If you specify -1, or a protocol number other than tcp, udp, icmp, or 58 (ICMPv6), traffic on all ports is allowed, regardless of any ports you specify. For tcp, udp, and icmp, you must specify a port range. For protocol 58 (ICMPv6), you can optionally specify a port range; if you don’t, traffic for all types and codes is allowed.

Type:string or undefined (abstract)
toPort

End of port range for the TCP and UDP protocols, or an ICMP code. If you specify icmp for the IpProtocol property, you can specify -1 as a wildcard (i.e., any ICMP code).

Type:number or undefined (abstract)

Connections

class @aws-cdk/aws-ec2.Connections(props)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.Connections;
const { Connections } = require('@aws-cdk/aws-ec2');
import { Connections } from '@aws-cdk/aws-ec2';

Manage the allowed network connections for constructs with Security Groups. Security Groups can be thought of as a firewall for network-connected devices. This class makes it easy to allow network connections to and from security groups, and between security groups individually. When establishing connectivity between security groups, it will automatically add rules in both security groups

Parameters:props (ConnectionsProps) –
allowDefaultPortFrom(other[, description])

Allow connections from the peer on our default port Even if the peer has a default port, we will always use our default port.

Parameters:
  • other (IConnectable) –
  • description (string or undefined) –
allowDefaultPortFromAnyIpv4([description])

Allow default connections from all IPv4 ranges

Parameters:description (string or undefined) –
allowDefaultPortInternally([description])

Allow hosts inside the security group to connect to each other

Parameters:description (string or undefined) –
allowDefaultPortTo(other[, description])

Allow connections from the peer on our default port Even if the peer has a default port, we will always use our default port.

Parameters:
  • other (IConnectable) –
  • description (string or undefined) –
allowFrom(other, portRange[, description])

Allow connections from the peer on the given port

Parameters:
allowFromAnyIPv4(portRange[, description])

Allow from any IPv4 ranges

Parameters:
  • portRange (IPortRange) –
  • description (string or undefined) –
allowInternally(portRange[, description])

Allow hosts inside the security group to connect to each other on the given port

Parameters:
  • portRange (IPortRange) –
  • description (string or undefined) –
allowTo(other, portRange[, description])

Allow connections to the peer on the given port

Parameters:
allowToAnyIPv4(portRange[, description])

Allow to all IPv4 ranges

Parameters:
  • portRange (IPortRange) –
  • description (string or undefined) –
allowToDefaultPort(other[, description])

Allow connections to the security group on their default port

Parameters:
  • other (IConnectable) –
  • description (string or undefined) –
securityGroupRule

The rule that defines how to represent this peer in a security group

Type:ISecurityGroupRule (readonly)
defaultPortRange

The default port configured for this connection peer, if available

Type:IPortRange or undefined (readonly)
securityGroup

Underlying securityGroup for this Connections object, if present May be empty if this Connections object is not managing a SecurityGroup, but simply representing a Connectable peer.

Type:SecurityGroupRef or undefined (readonly)

ConnectionsProps (interface)

class @aws-cdk/aws-ec2.ConnectionsProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.ConnectionsProps;
// ConnectionsProps is an interface
import { ConnectionsProps } from '@aws-cdk/aws-ec2';

Properties to intialize a new Connections object

defaultPortRange

Default port range for initiating connections to and from this object

Type:IPortRange or undefined (abstract)
securityGroup

What securityGroup this object is managing connections for

Type:SecurityGroupRef or undefined (abstract)
securityGroupRule

Class that represents the rule by which others can connect to this connectable This object is required, but will be derived from securityGroup if that is passed.

Type:ISecurityGroupRule or undefined (abstract)

DefaultInstanceTenancy (enum)

class @aws-cdk/aws-ec2.DefaultInstanceTenancy

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.DefaultInstanceTenancy;
const { DefaultInstanceTenancy } = require('@aws-cdk/aws-ec2');
import { DefaultInstanceTenancy } from '@aws-cdk/aws-ec2';

The default tenancy of instances launched into the VPC.

Default

Instances can be launched with any tenancy.

Dedicated

Any instance launched into the VPC automatically has dedicated tenancy, unless you launch it with the default tenancy.

GenericLinuxImage

class @aws-cdk/aws-ec2.GenericLinuxImage(amiMap)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.GenericLinuxImage;
const { GenericLinuxImage } = require('@aws-cdk/aws-ec2');
import { GenericLinuxImage } from '@aws-cdk/aws-ec2';

Construct a Linux machine image from an AMI map Linux images IDs are not published to SSM parameter store yet, so you’ll have to manually specify an AMI map.

Implements:IMachineImageSource
Parameters:amiMap (string => string) –
getImage(parent) → @aws-cdk/aws-ec2.MachineImage

Implements @aws-cdk/aws-ec2.IMachineImageSource.getImage()

Return the image to use in the given context

Parameters:parent (@aws-cdk/cdk.Construct) –
Return type:MachineImage
amiMap
Type:string => string (readonly)

IConnectable (interface)

class @aws-cdk/aws-ec2.IConnectable

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.IConnectable;
// IConnectable is an interface
import { IConnectable } from '@aws-cdk/aws-ec2';

The goal of this module is to make possible to write statements like this: `ts  *  database.connections.allowFrom(fleet);  *  fleet.connections.allowTo(database);  *  rdgw.connections.allowFromCidrIp('0.3.1.5/86');  *  rgdw.connections.allowTrafficTo(fleet, new AllPorts());  *  ` The insight here is that some connecting peers have information on what ports should be involved in the connection, and some don’t. An object that has a Connections object

connections
Type:Connections (readonly) (abstract)

IMachineImageSource (interface)

class @aws-cdk/aws-ec2.IMachineImageSource

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.IMachineImageSource;
// IMachineImageSource is an interface
import { IMachineImageSource } from '@aws-cdk/aws-ec2';

Interface for classes that can select an appropriate machine image to use

getImage(parent) → @aws-cdk/aws-ec2.MachineImage

Return the image to use in the given context

Parameters:parent (@aws-cdk/cdk.Construct) –
Return type:MachineImage
Abstract:Yes

IPortRange (interface)

class @aws-cdk/aws-ec2.IPortRange

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.IPortRange;
// IPortRange is an interface
import { IPortRange } from '@aws-cdk/aws-ec2';

Interface for classes that provide the connection-specification parts of a security group rule

canInlineRule

Whether the rule containing this port range can be inlined into a securitygroup or not.

Type:boolean (readonly) (abstract)
toRuleJSON() → any

Produce the ingress/egress rule JSON for the given connection

Return type:any or undefined
Abstract:Yes

ISecurityGroupRule (interface)

class @aws-cdk/aws-ec2.ISecurityGroupRule

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.ISecurityGroupRule;
// ISecurityGroupRule is an interface
import { ISecurityGroupRule } from '@aws-cdk/aws-ec2';

Interface for classes that provide the peer-specification parts of a security group rule

canInlineRule

Whether the rule can be inlined into a SecurityGroup or not

Type:boolean (readonly) (abstract)
uniqueId

A unique identifier for this connection peer

Type:string (readonly) (abstract)
toEgressRuleJSON() → any

Produce the egress rule JSON for the given connection

Return type:any or undefined
Abstract:Yes
toIngressRuleJSON() → any

Produce the ingress rule JSON for the given connection

Return type:any or undefined
Abstract:Yes

IcmpAllTypeCodes

class @aws-cdk/aws-ec2.IcmpAllTypeCodes(type)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.IcmpAllTypeCodes;
const { IcmpAllTypeCodes } = require('@aws-cdk/aws-ec2');
import { IcmpAllTypeCodes } from '@aws-cdk/aws-ec2';

All ICMP Codes for a given ICMP Type

Implements:IPortRange
Parameters:type (number) –
toRuleJSON() → any

Implements @aws-cdk/aws-ec2.IPortRange.toRuleJSON()

Produce the ingress/egress rule JSON for the given connection

Return type:any or undefined
toString() → string

Returns a string representation of an object.

Return type:string
canInlineRule

Implements @aws-cdk/aws-ec2.IPortRange.canInlineRule()

Whether the rule containing this port range can be inlined into a securitygroup or not.

Type:boolean (readonly)
type
Type:number (readonly)

IcmpAllTypesAndCodes

class @aws-cdk/aws-ec2.IcmpAllTypesAndCodes

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.IcmpAllTypesAndCodes;
const { IcmpAllTypesAndCodes } = require('@aws-cdk/aws-ec2');
import { IcmpAllTypesAndCodes } from '@aws-cdk/aws-ec2';

All ICMP Types & Codes

Implements:IPortRange
toRuleJSON() → any

Implements @aws-cdk/aws-ec2.IPortRange.toRuleJSON()

Produce the ingress/egress rule JSON for the given connection

Return type:any or undefined
toString() → string

Returns a string representation of an object.

Return type:string
canInlineRule

Implements @aws-cdk/aws-ec2.IPortRange.canInlineRule()

Whether the rule containing this port range can be inlined into a securitygroup or not.

Type:boolean (readonly)

IcmpPing

class @aws-cdk/aws-ec2.IcmpPing

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.IcmpPing;
const { IcmpPing } = require('@aws-cdk/aws-ec2');
import { IcmpPing } from '@aws-cdk/aws-ec2';

ICMP Ping traffic

Implements:IPortRange
toRuleJSON() → any

Implements @aws-cdk/aws-ec2.IPortRange.toRuleJSON()

Produce the ingress/egress rule JSON for the given connection

Return type:any or undefined
toString() → string

Returns a string representation of an object.

Return type:string
canInlineRule

Implements @aws-cdk/aws-ec2.IPortRange.canInlineRule()

Whether the rule containing this port range can be inlined into a securitygroup or not.

Type:boolean (readonly)

IcmpTypeAndCode

class @aws-cdk/aws-ec2.IcmpTypeAndCode(type, code)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.IcmpTypeAndCode;
const { IcmpTypeAndCode } = require('@aws-cdk/aws-ec2');
import { IcmpTypeAndCode } from '@aws-cdk/aws-ec2';

A set of matching ICMP Type & Code

Implements:

IPortRange

Parameters:
  • type (number) –
  • code (number) –
toRuleJSON() → any

Implements @aws-cdk/aws-ec2.IPortRange.toRuleJSON()

Produce the ingress/egress rule JSON for the given connection

Return type:any or undefined
toString() → string

Returns a string representation of an object.

Return type:string
canInlineRule

Implements @aws-cdk/aws-ec2.IPortRange.canInlineRule()

Whether the rule containing this port range can be inlined into a securitygroup or not.

Type:boolean (readonly)
code
Type:number (readonly)
type
Type:number (readonly)

InstanceClass (enum)

class @aws-cdk/aws-ec2.InstanceClass

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.InstanceClass;
const { InstanceClass } = require('@aws-cdk/aws-ec2');
import { InstanceClass } from '@aws-cdk/aws-ec2';

What class and generation of instance to use We have both symbolic and concrete enums for every type. The first are for people that want to specify by purpose, the second one are for people who already know exactly what ‘R4’ means.

Standard3

Standard instances, 3rd generation

Standard4

Standard instances, 4th generation

Standard5

Standard instances, 5th generation

Memory3

Memory optimized instances, 3rd generation

Memory4

Memory optimized instances, 3rd generation

Compute3

Compute optimized instances, 3rd generation

Compute4

Compute optimized instances, 4th generation

Compute5

Compute optimized instances, 5th generation

Storage2

Storage-optimized instances, 2nd generation

StorageCompute1

Storage/compute balanced instances, 1st generation

Io3

I/O-optimized instances, 3rd generation

Burstable2

Burstable instances, 2nd generation

Burstable3

Burstable instances, 3rd generation

MemoryIntensive1

Memory-intensive instances, 1st generation

MemoryIntensive1Extended

Memory-intensive instances, extended, 1st generation

Fpga1

Instances with customizable hardware acceleration, 1st generation

Graphics3

Graphics-optimized instances, 3rd generation

Parallel2

Parallel-processing optimized instances, 2nd generation

Parallel3

Parallel-processing optimized instances, 3nd generation

InstanceSize (enum)

class @aws-cdk/aws-ec2.InstanceSize

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.InstanceSize;
const { InstanceSize } = require('@aws-cdk/aws-ec2');
import { InstanceSize } from '@aws-cdk/aws-ec2';

What size of instance to use

None
Micro
Small
Medium
Large
XLarge
XLarge2
XLarge4
XLarge8
XLarge9
XLarge10
XLarge12
XLarge16
XLarge18
XLarge24
XLarge32

InstanceType

class @aws-cdk/aws-ec2.InstanceType(instanceTypeIdentifier)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.InstanceType;
const { InstanceType } = require('@aws-cdk/aws-ec2');
import { InstanceType } from '@aws-cdk/aws-ec2';

Instance type for EC2 instances This class takes a literal string, good if you already know the identifier of the type you want.

Parameters:instanceTypeIdentifier (string) –
toString() → string

Return the instance type as a dotted string

Return type:string
instanceTypeIdentifier
Type:string (readonly)

InstanceTypePair

class @aws-cdk/aws-ec2.InstanceTypePair(instanceClass, instanceSize)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.InstanceTypePair;
const { InstanceTypePair } = require('@aws-cdk/aws-ec2');
import { InstanceTypePair } from '@aws-cdk/aws-ec2';

Instance type for EC2 instances This class takes a combination of a class and size. Be aware that not all combinations of class and size are available, and not all classes are available in all regions.

Extends:

InstanceType

Parameters:
instanceClass
Type:InstanceClass (readonly)
instanceSize
Type:InstanceSize (readonly)
toString() → string

Inherited from @aws-cdk/aws-ec2.InstanceType

Return the instance type as a dotted string

Return type:string
instanceTypeIdentifier

Inherited from @aws-cdk/aws-ec2.InstanceType

Type:string (readonly)

LinuxOS

class @aws-cdk/aws-ec2.LinuxOS

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.LinuxOS;
const { LinuxOS } = require('@aws-cdk/aws-ec2');
import { LinuxOS } from '@aws-cdk/aws-ec2';

OS features specialized for Linux

Extends:OperatingSystem
createUserData(scripts) → string

Implements @aws-cdk/aws-ec2.OperatingSystem.createUserData()

Parameters:scripts (string[]) –
Return type:string
type

Implements @aws-cdk/aws-ec2.OperatingSystem.type()

Type:OperatingSystemType (readonly)

MachineImage

class @aws-cdk/aws-ec2.MachineImage(imageId, os)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.MachineImage;
const { MachineImage } = require('@aws-cdk/aws-ec2');
import { MachineImage } from '@aws-cdk/aws-ec2';

Representation of a machine to be launched Combines an AMI ID with an OS.

Parameters:
imageId
Type:string (readonly)
os
Type:OperatingSystem (readonly)

NetworkInterfaceSecondaryPrivateIpAddresses

class @aws-cdk/aws-ec2.NetworkInterfaceSecondaryPrivateIpAddresses([valueOrFunction[, displayName]])

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.NetworkInterfaceSecondaryPrivateIpAddresses;
const { NetworkInterfaceSecondaryPrivateIpAddresses } = require('@aws-cdk/aws-ec2');
import { NetworkInterfaceSecondaryPrivateIpAddresses } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Token

Parameters:
  • valueOrFunction (any or undefined) – What this token will evaluate to, literal or function.
  • displayName (string or undefined) – A human-readable display hint for this Token
concat([left[, right]]) → @aws-cdk/cdk.Token

Inherited from @aws-cdk/cdk.Token

Return a concated version of this Token in a string context The default implementation of this combines strings, but specialized implements of Token can return a more appropriate value.

Parameters:
  • left (any or undefined) –
  • right (any or undefined) –
Return type:

@aws-cdk/cdk.Token

resolve() → any

Inherited from @aws-cdk/cdk.Token

Returns:The resolved value for this token.
Return type:any or undefined
toJSON() → any

Inherited from @aws-cdk/cdk.Token

Turn this Token into JSON This gets called by JSON.stringify(). We want to prohibit this, because it’s not possible to do this properly, so we just throw an error here.

Return type:any or undefined
toString() → string

Inherited from @aws-cdk/cdk.Token

Return a reversible string representation of this token If the Token is initialized with a literal, the stringified value of the literal is returned. Otherwise, a special quoted string representation of the Token is returned that can be embedded into other strings. Strings with quoted Tokens in them can be restored back into complex values with the Tokens restored by calling resolve() on the string.

Return type:string
displayName

Inherited from @aws-cdk/cdk.Token

A human-readable display hint for this Token

Type:string or undefined (readonly)
valueOrFunction

Inherited from @aws-cdk/cdk.Token

What this token will evaluate to, literal or function.

Type:any or undefined (readonly)

OperatingSystem

class @aws-cdk/aws-ec2.OperatingSystem

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.OperatingSystem;
const { OperatingSystem } = require('@aws-cdk/aws-ec2');
import { OperatingSystem } from '@aws-cdk/aws-ec2';

Abstraction of OS features we need to be aware of

Abstract:Yes
createUserData(scripts) → string
Parameters:scripts (string[]) –
Return type:string
Abstract:Yes
type
Type:OperatingSystemType (readonly) (abstract)

OperatingSystemType (enum)

class @aws-cdk/aws-ec2.OperatingSystemType

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.OperatingSystemType;
const { OperatingSystemType } = require('@aws-cdk/aws-ec2');
import { OperatingSystemType } from '@aws-cdk/aws-ec2';

The OS type of a particular image

Linux
Windows

PrefixList

class @aws-cdk/aws-ec2.PrefixList(prefixListId)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.PrefixList;
const { PrefixList } = require('@aws-cdk/aws-ec2');
import { PrefixList } from '@aws-cdk/aws-ec2';

A prefix list Prefix lists are used to allow traffic to VPC-local service endpoints. For more information, see this page: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/vpc-endpoints.html

Implements:ISecurityGroupRule
Implements:IConnectable
Parameters:prefixListId (string) –
toEgressRuleJSON() → any

Implements @aws-cdk/aws-ec2.ISecurityGroupRule.toEgressRuleJSON()

Produce the egress rule JSON for the given connection

Return type:any or undefined
toIngressRuleJSON() → any

Implements @aws-cdk/aws-ec2.ISecurityGroupRule.toIngressRuleJSON()

Produce the ingress rule JSON for the given connection

Return type:any or undefined
canInlineRule

Implements @aws-cdk/aws-ec2.ISecurityGroupRule.canInlineRule()

Whether the rule can be inlined into a SecurityGroup or not

Type:boolean (readonly)
connections

Implements @aws-cdk/aws-ec2.IConnectable.connections()

Type:Connections (readonly)
prefixListId
Type:string (readonly)
uniqueId

Implements @aws-cdk/aws-ec2.ISecurityGroupRule.uniqueId()

A unique identifier for this connection peer

Type:string (readonly)

Protocol (enum)

class @aws-cdk/aws-ec2.Protocol

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.Protocol;
const { Protocol } = require('@aws-cdk/aws-ec2');
import { Protocol } from '@aws-cdk/aws-ec2';

Protocol for use in Connection Rules

All
Tcp
Udp
Icmp
Icmpv6

SecurityGroup

class @aws-cdk/aws-ec2.SecurityGroup(parent, name, props)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.SecurityGroup;
const { SecurityGroup } = require('@aws-cdk/aws-ec2');
import { SecurityGroup } from '@aws-cdk/aws-ec2';

Creates an Amazon EC2 security group within a VPC. This class has an additional optimization over SecurityGroupRef that it can also create inline ingress and egress rule (which saves on the total number of resources inside the template).

Extends:

SecurityGroupRef

Implements:

@aws-cdk/cdk.ITaggable

Parameters:
addEgressRule(peer, connection[, description])

Overrides @aws-cdk/aws-ec2.SecurityGroupRef.addEgressRule()

Parameters:
addIngressRule(peer, connection[, description])

Overrides @aws-cdk/aws-ec2.SecurityGroupRef.addIngressRule()

Parameters:
groupName

An attribute that represents the security group name.

Type:string (readonly)
securityGroupId

Implements @aws-cdk/aws-ec2.SecurityGroupRef.securityGroupId()

The ID of the security group

Type:string (readonly)
tags

Implements @aws-cdk/cdk.ITaggable.tags()

Manage tags for this construct and children

Type:@aws-cdk/cdk.TagManager (readonly)
vpcId

An attribute that represents the physical VPC ID this security group is part of.

Type:string (readonly)
export() → @aws-cdk/aws-ec2.SecurityGroupRefProps

Inherited from @aws-cdk/aws-ec2.SecurityGroupRef

Export this SecurityGroup for use in a different Stack

Return type:SecurityGroupRefProps
toEgressRuleJSON() → any

Inherited from @aws-cdk/aws-ec2.SecurityGroupRef

Produce the egress rule JSON for the given connection

Return type:any or undefined
toIngressRuleJSON() → any

Inherited from @aws-cdk/aws-ec2.SecurityGroupRef

Produce the ingress rule JSON for the given connection

Return type:any or undefined
canInlineRule

Inherited from @aws-cdk/aws-ec2.SecurityGroupRef

Whether the rule can be inlined into a SecurityGroup or not

Type:boolean (readonly)
connections

Inherited from @aws-cdk/aws-ec2.SecurityGroupRef

Type:Connections (readonly)
defaultPortRange

Inherited from @aws-cdk/aws-ec2.SecurityGroupRef

FIXME: Where to place this??

Type:IPortRange or undefined (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)

SecurityGroupProps (interface)

class @aws-cdk/aws-ec2.SecurityGroupProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.SecurityGroupProps;
// SecurityGroupProps is an interface
import { SecurityGroupProps } from '@aws-cdk/aws-ec2';
vpc

The VPC in which to create the security group.

Type:VpcNetworkRef (abstract)
allowAllOutbound

Whether to allow all outbound traffic by default. If this is set to true, there will only be a single egress rule which allows all outbound traffic. If this is set to false, no outbound traffic will be allowed by default and all egress traffic must be explicitly authorized.

Type:boolean or undefined (abstract)
description

A description of the security group.

Type:string or undefined (abstract)
groupName

The name of the security group. For valid values, see the GroupName parameter of the CreateSecurityGroup action in the Amazon EC2 API Reference. It is not recommended to use an explicit group name.

Type:string or undefined (abstract)
tags

The AWS resource tags to associate with the security group.

Type:string => string or undefined (abstract)

SecurityGroupRef

class @aws-cdk/aws-ec2.SecurityGroupRef(parent, id)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.SecurityGroupRef;
const { SecurityGroupRef } = require('@aws-cdk/aws-ec2');
import { SecurityGroupRef } from '@aws-cdk/aws-ec2';

A SecurityGroup that is not created in this template

Extends:

@aws-cdk/cdk.Construct

Implements:

ISecurityGroupRule

Implements:

IConnectable

Abstract:

Yes

Parameters:
static import(parent, id, props) → @aws-cdk/aws-ec2.SecurityGroupRef

Import an existing SecurityGroup

Parameters:
Return type:

SecurityGroupRef

addEgressRule(peer, connection[, description])
Parameters:
addIngressRule(peer, connection[, description])
Parameters:
export() → @aws-cdk/aws-ec2.SecurityGroupRefProps

Export this SecurityGroup for use in a different Stack

Return type:SecurityGroupRefProps
toEgressRuleJSON() → any

Implements @aws-cdk/aws-ec2.ISecurityGroupRule.toEgressRuleJSON()

Produce the egress rule JSON for the given connection

Return type:any or undefined
toIngressRuleJSON() → any

Implements @aws-cdk/aws-ec2.ISecurityGroupRule.toIngressRuleJSON()

Produce the ingress rule JSON for the given connection

Return type:any or undefined
canInlineRule

Implements @aws-cdk/aws-ec2.ISecurityGroupRule.canInlineRule()

Whether the rule can be inlined into a SecurityGroup or not

Type:boolean (readonly)
connections

Implements @aws-cdk/aws-ec2.IConnectable.connections()

Type:Connections (readonly)
securityGroupId
Type:string (readonly) (abstract)
defaultPortRange

FIXME: Where to place this??

Type:IPortRange or undefined (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)

SecurityGroupRefProps (interface)

class @aws-cdk/aws-ec2.SecurityGroupRefProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.SecurityGroupRefProps;
// SecurityGroupRefProps is an interface
import { SecurityGroupRefProps } from '@aws-cdk/aws-ec2';
securityGroupId

ID of security group

Type:string (abstract)

SubnetConfiguration (interface)

class @aws-cdk/aws-ec2.SubnetConfiguration

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.SubnetConfiguration;
// SubnetConfiguration is an interface
import { SubnetConfiguration } from '@aws-cdk/aws-ec2';

Specify configuration parameters for a VPC to be built

name

The common Logical Name for the VpcSubnet Thi name will be suffixed with an integer correlating to a specific availability zone.

Type:string (abstract)
subnetType

The type of Subnet to configure. The Subnet type will control the ability to route and connect to the Internet.

Type:SubnetType (abstract)
cidrMask

The CIDR Mask or the number of leading 1 bits in the routing mask Valid values are 16 - 28

Type:number or undefined (abstract)
tags

The AWS resource tags to associate with the resource.

Type:string => string or undefined (abstract)

SubnetIpv6CidrBlocks

class @aws-cdk/aws-ec2.SubnetIpv6CidrBlocks([valueOrFunction[, displayName]])

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.SubnetIpv6CidrBlocks;
const { SubnetIpv6CidrBlocks } = require('@aws-cdk/aws-ec2');
import { SubnetIpv6CidrBlocks } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Token

Parameters:
  • valueOrFunction (any or undefined) – What this token will evaluate to, literal or function.
  • displayName (string or undefined) – A human-readable display hint for this Token
concat([left[, right]]) → @aws-cdk/cdk.Token

Inherited from @aws-cdk/cdk.Token

Return a concated version of this Token in a string context The default implementation of this combines strings, but specialized implements of Token can return a more appropriate value.

Parameters:
  • left (any or undefined) –
  • right (any or undefined) –
Return type:

@aws-cdk/cdk.Token

resolve() → any

Inherited from @aws-cdk/cdk.Token

Returns:The resolved value for this token.
Return type:any or undefined
toJSON() → any

Inherited from @aws-cdk/cdk.Token

Turn this Token into JSON This gets called by JSON.stringify(). We want to prohibit this, because it’s not possible to do this properly, so we just throw an error here.

Return type:any or undefined
toString() → string

Inherited from @aws-cdk/cdk.Token

Return a reversible string representation of this token If the Token is initialized with a literal, the stringified value of the literal is returned. Otherwise, a special quoted string representation of the Token is returned that can be embedded into other strings. Strings with quoted Tokens in them can be restored back into complex values with the Tokens restored by calling resolve() on the string.

Return type:string
displayName

Inherited from @aws-cdk/cdk.Token

A human-readable display hint for this Token

Type:string or undefined (readonly)
valueOrFunction

Inherited from @aws-cdk/cdk.Token

What this token will evaluate to, literal or function.

Type:any or undefined (readonly)

SubnetType (enum)

class @aws-cdk/aws-ec2.SubnetType

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.SubnetType;
const { SubnetType } = require('@aws-cdk/aws-ec2');
import { SubnetType } from '@aws-cdk/aws-ec2';

The type of Subnet

Isolated

Isolated Subnets do not route Outbound traffic This can be good for subnets with RDS or Elasticache endpoints

Private

Subnet that routes to the internet, but not vice versa. Instances in a private subnet can connect to the Internet, but will not allow connections to be initiated from the Internet. Outbound traffic will be routed via a NAT Gateway. Preference being in the same AZ, but if not available will use another AZ (control by specifing maxGateways on VpcNetwork). This might be used for experimental cost conscious accounts or accounts where HA outbound traffic is not needed.

Public

Subnet connected to the Internet Instances in a Public subnet can connect to the Internet and can be connected to from the Internet as long as they are launched with public IPs (controlled on the AutoScalingGroup or other constructs that launch instances). Public subnets route outbound traffic via an Internet Gateway.

TcpAllPorts

class @aws-cdk/aws-ec2.TcpAllPorts

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.TcpAllPorts;
const { TcpAllPorts } = require('@aws-cdk/aws-ec2');
import { TcpAllPorts } from '@aws-cdk/aws-ec2';

All TCP Ports

Implements:IPortRange
toRuleJSON() → any

Implements @aws-cdk/aws-ec2.IPortRange.toRuleJSON()

Produce the ingress/egress rule JSON for the given connection

Return type:any or undefined
toString() → string

Returns a string representation of an object.

Return type:string
canInlineRule

Implements @aws-cdk/aws-ec2.IPortRange.canInlineRule()

Whether the rule containing this port range can be inlined into a securitygroup or not.

Type:boolean (readonly)

TcpPort

class @aws-cdk/aws-ec2.TcpPort(port)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.TcpPort;
const { TcpPort } = require('@aws-cdk/aws-ec2');
import { TcpPort } from '@aws-cdk/aws-ec2';

A single TCP port

Implements:IPortRange
Parameters:port (number) –
toRuleJSON() → any

Implements @aws-cdk/aws-ec2.IPortRange.toRuleJSON()

Produce the ingress/egress rule JSON for the given connection

Return type:any or undefined
toString() → string

Returns a string representation of an object.

Return type:string
canInlineRule

Implements @aws-cdk/aws-ec2.IPortRange.canInlineRule()

Whether the rule containing this port range can be inlined into a securitygroup or not.

Type:boolean (readonly)
port
Type:number (readonly)

TcpPortFromAttribute

class @aws-cdk/aws-ec2.TcpPortFromAttribute(port)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.TcpPortFromAttribute;
const { TcpPortFromAttribute } = require('@aws-cdk/aws-ec2');
import { TcpPortFromAttribute } from '@aws-cdk/aws-ec2';

A single TCP port that is provided by a resource attribute

Implements:IPortRange
Parameters:port (string) –
toRuleJSON() → any

Implements @aws-cdk/aws-ec2.IPortRange.toRuleJSON()

Produce the ingress/egress rule JSON for the given connection

Return type:any or undefined
toString() → string

Returns a string representation of an object.

Return type:string
canInlineRule

Implements @aws-cdk/aws-ec2.IPortRange.canInlineRule()

Whether the rule containing this port range can be inlined into a securitygroup or not.

Type:boolean (readonly)
port
Type:string (readonly)

TcpPortRange

class @aws-cdk/aws-ec2.TcpPortRange(startPort, endPort)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.TcpPortRange;
const { TcpPortRange } = require('@aws-cdk/aws-ec2');
import { TcpPortRange } from '@aws-cdk/aws-ec2';

A TCP port range

Implements:

IPortRange

Parameters:
  • startPort (number) –
  • endPort (number) –
toRuleJSON() → any

Implements @aws-cdk/aws-ec2.IPortRange.toRuleJSON()

Produce the ingress/egress rule JSON for the given connection

Return type:any or undefined
toString() → string

Returns a string representation of an object.

Return type:string
canInlineRule

Implements @aws-cdk/aws-ec2.IPortRange.canInlineRule()

Whether the rule containing this port range can be inlined into a securitygroup or not.

Type:boolean (readonly)
endPort
Type:number (readonly)
startPort
Type:number (readonly)

UdpAllPorts

class @aws-cdk/aws-ec2.UdpAllPorts

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.UdpAllPorts;
const { UdpAllPorts } = require('@aws-cdk/aws-ec2');
import { UdpAllPorts } from '@aws-cdk/aws-ec2';

All UDP Ports

Implements:IPortRange
toRuleJSON() → any

Implements @aws-cdk/aws-ec2.IPortRange.toRuleJSON()

Produce the ingress/egress rule JSON for the given connection

Return type:any or undefined
toString() → string

Returns a string representation of an object.

Return type:string
canInlineRule

Implements @aws-cdk/aws-ec2.IPortRange.canInlineRule()

Whether the rule containing this port range can be inlined into a securitygroup or not.

Type:boolean (readonly)

UdpPort

class @aws-cdk/aws-ec2.UdpPort(port)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.UdpPort;
const { UdpPort } = require('@aws-cdk/aws-ec2');
import { UdpPort } from '@aws-cdk/aws-ec2';

A single UDP port

Implements:IPortRange
Parameters:port (number) –
toRuleJSON() → any

Implements @aws-cdk/aws-ec2.IPortRange.toRuleJSON()

Produce the ingress/egress rule JSON for the given connection

Return type:any or undefined
toString() → string

Returns a string representation of an object.

Return type:string
canInlineRule

Implements @aws-cdk/aws-ec2.IPortRange.canInlineRule()

Whether the rule containing this port range can be inlined into a securitygroup or not.

Type:boolean (readonly)
port
Type:number (readonly)

UdpPortFromAttribute

class @aws-cdk/aws-ec2.UdpPortFromAttribute(port)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.UdpPortFromAttribute;
const { UdpPortFromAttribute } = require('@aws-cdk/aws-ec2');
import { UdpPortFromAttribute } from '@aws-cdk/aws-ec2';

A single UDP port that is provided by a resource attribute

Implements:IPortRange
Parameters:port (string) –
toRuleJSON() → any

Implements @aws-cdk/aws-ec2.IPortRange.toRuleJSON()

Produce the ingress/egress rule JSON for the given connection

Return type:any or undefined
toString() → string

Returns a string representation of an object.

Return type:string
canInlineRule

Implements @aws-cdk/aws-ec2.IPortRange.canInlineRule()

Whether the rule containing this port range can be inlined into a securitygroup or not.

Type:boolean (readonly)
port
Type:string (readonly)

UdpPortRange

class @aws-cdk/aws-ec2.UdpPortRange(startPort, endPort)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.UdpPortRange;
const { UdpPortRange } = require('@aws-cdk/aws-ec2');
import { UdpPortRange } from '@aws-cdk/aws-ec2';

A UDP port range

Implements:

IPortRange

Parameters:
  • startPort (number) –
  • endPort (number) –
toRuleJSON() → any

Implements @aws-cdk/aws-ec2.IPortRange.toRuleJSON()

Produce the ingress/egress rule JSON for the given connection

Return type:any or undefined
toString() → string

Returns a string representation of an object.

Return type:string
canInlineRule

Implements @aws-cdk/aws-ec2.IPortRange.canInlineRule()

Whether the rule containing this port range can be inlined into a securitygroup or not.

Type:boolean (readonly)
endPort
Type:number (readonly)
startPort
Type:number (readonly)

VPCCidrBlockAssociations

class @aws-cdk/aws-ec2.VPCCidrBlockAssociations([valueOrFunction[, displayName]])

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VPCCidrBlockAssociations;
const { VPCCidrBlockAssociations } = require('@aws-cdk/aws-ec2');
import { VPCCidrBlockAssociations } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Token

Parameters:
  • valueOrFunction (any or undefined) – What this token will evaluate to, literal or function.
  • displayName (string or undefined) – A human-readable display hint for this Token
concat([left[, right]]) → @aws-cdk/cdk.Token

Inherited from @aws-cdk/cdk.Token

Return a concated version of this Token in a string context The default implementation of this combines strings, but specialized implements of Token can return a more appropriate value.

Parameters:
  • left (any or undefined) –
  • right (any or undefined) –
Return type:

@aws-cdk/cdk.Token

resolve() → any

Inherited from @aws-cdk/cdk.Token

Returns:The resolved value for this token.
Return type:any or undefined
toJSON() → any

Inherited from @aws-cdk/cdk.Token

Turn this Token into JSON This gets called by JSON.stringify(). We want to prohibit this, because it’s not possible to do this properly, so we just throw an error here.

Return type:any or undefined
toString() → string

Inherited from @aws-cdk/cdk.Token

Return a reversible string representation of this token If the Token is initialized with a literal, the stringified value of the literal is returned. Otherwise, a special quoted string representation of the Token is returned that can be embedded into other strings. Strings with quoted Tokens in them can be restored back into complex values with the Tokens restored by calling resolve() on the string.

Return type:string
displayName

Inherited from @aws-cdk/cdk.Token

A human-readable display hint for this Token

Type:string or undefined (readonly)
valueOrFunction

Inherited from @aws-cdk/cdk.Token

What this token will evaluate to, literal or function.

Type:any or undefined (readonly)

VPCEndpointDnsEntries

class @aws-cdk/aws-ec2.VPCEndpointDnsEntries([valueOrFunction[, displayName]])

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VPCEndpointDnsEntries;
const { VPCEndpointDnsEntries } = require('@aws-cdk/aws-ec2');
import { VPCEndpointDnsEntries } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Token

Parameters:
  • valueOrFunction (any or undefined) – What this token will evaluate to, literal or function.
  • displayName (string or undefined) – A human-readable display hint for this Token
concat([left[, right]]) → @aws-cdk/cdk.Token

Inherited from @aws-cdk/cdk.Token

Return a concated version of this Token in a string context The default implementation of this combines strings, but specialized implements of Token can return a more appropriate value.

Parameters:
  • left (any or undefined) –
  • right (any or undefined) –
Return type:

@aws-cdk/cdk.Token

resolve() → any

Inherited from @aws-cdk/cdk.Token

Returns:The resolved value for this token.
Return type:any or undefined
toJSON() → any

Inherited from @aws-cdk/cdk.Token

Turn this Token into JSON This gets called by JSON.stringify(). We want to prohibit this, because it’s not possible to do this properly, so we just throw an error here.

Return type:any or undefined
toString() → string

Inherited from @aws-cdk/cdk.Token

Return a reversible string representation of this token If the Token is initialized with a literal, the stringified value of the literal is returned. Otherwise, a special quoted string representation of the Token is returned that can be embedded into other strings. Strings with quoted Tokens in them can be restored back into complex values with the Tokens restored by calling resolve() on the string.

Return type:string
displayName

Inherited from @aws-cdk/cdk.Token

A human-readable display hint for this Token

Type:string or undefined (readonly)
valueOrFunction

Inherited from @aws-cdk/cdk.Token

What this token will evaluate to, literal or function.

Type:any or undefined (readonly)

VPCEndpointNetworkInterfaceIds

class @aws-cdk/aws-ec2.VPCEndpointNetworkInterfaceIds([valueOrFunction[, displayName]])

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VPCEndpointNetworkInterfaceIds;
const { VPCEndpointNetworkInterfaceIds } = require('@aws-cdk/aws-ec2');
import { VPCEndpointNetworkInterfaceIds } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Token

Parameters:
  • valueOrFunction (any or undefined) – What this token will evaluate to, literal or function.
  • displayName (string or undefined) – A human-readable display hint for this Token
concat([left[, right]]) → @aws-cdk/cdk.Token

Inherited from @aws-cdk/cdk.Token

Return a concated version of this Token in a string context The default implementation of this combines strings, but specialized implements of Token can return a more appropriate value.

Parameters:
  • left (any or undefined) –
  • right (any or undefined) –
Return type:

@aws-cdk/cdk.Token

resolve() → any

Inherited from @aws-cdk/cdk.Token

Returns:The resolved value for this token.
Return type:any or undefined
toJSON() → any

Inherited from @aws-cdk/cdk.Token

Turn this Token into JSON This gets called by JSON.stringify(). We want to prohibit this, because it’s not possible to do this properly, so we just throw an error here.

Return type:any or undefined
toString() → string

Inherited from @aws-cdk/cdk.Token

Return a reversible string representation of this token If the Token is initialized with a literal, the stringified value of the literal is returned. Otherwise, a special quoted string representation of the Token is returned that can be embedded into other strings. Strings with quoted Tokens in them can be restored back into complex values with the Tokens restored by calling resolve() on the string.

Return type:string
displayName

Inherited from @aws-cdk/cdk.Token

A human-readable display hint for this Token

Type:string or undefined (readonly)
valueOrFunction

Inherited from @aws-cdk/cdk.Token

What this token will evaluate to, literal or function.

Type:any or undefined (readonly)

VPCIpv6CidrBlocks

class @aws-cdk/aws-ec2.VPCIpv6CidrBlocks([valueOrFunction[, displayName]])

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VPCIpv6CidrBlocks;
const { VPCIpv6CidrBlocks } = require('@aws-cdk/aws-ec2');
import { VPCIpv6CidrBlocks } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Token

Parameters:
  • valueOrFunction (any or undefined) – What this token will evaluate to, literal or function.
  • displayName (string or undefined) – A human-readable display hint for this Token
concat([left[, right]]) → @aws-cdk/cdk.Token

Inherited from @aws-cdk/cdk.Token

Return a concated version of this Token in a string context The default implementation of this combines strings, but specialized implements of Token can return a more appropriate value.

Parameters:
  • left (any or undefined) –
  • right (any or undefined) –
Return type:

@aws-cdk/cdk.Token

resolve() → any

Inherited from @aws-cdk/cdk.Token

Returns:The resolved value for this token.
Return type:any or undefined
toJSON() → any

Inherited from @aws-cdk/cdk.Token

Turn this Token into JSON This gets called by JSON.stringify(). We want to prohibit this, because it’s not possible to do this properly, so we just throw an error here.

Return type:any or undefined
toString() → string

Inherited from @aws-cdk/cdk.Token

Return a reversible string representation of this token If the Token is initialized with a literal, the stringified value of the literal is returned. Otherwise, a special quoted string representation of the Token is returned that can be embedded into other strings. Strings with quoted Tokens in them can be restored back into complex values with the Tokens restored by calling resolve() on the string.

Return type:string
displayName

Inherited from @aws-cdk/cdk.Token

A human-readable display hint for this Token

Type:string or undefined (readonly)
valueOrFunction

Inherited from @aws-cdk/cdk.Token

What this token will evaluate to, literal or function.

Type:any or undefined (readonly)

VpcNetwork

class @aws-cdk/aws-ec2.VpcNetwork(parent, name[, props])

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VpcNetwork;
const { VpcNetwork } = require('@aws-cdk/aws-ec2');
import { VpcNetwork } from '@aws-cdk/aws-ec2';

VpcNetwork deploys an AWS VPC, with public and private subnets per Availability Zone. For example: import { VpcNetwork } from @aws-cdk/aws-ec2’ const vpc = new VpcNetwork(this, { cidr: “10.0.0.0/16” }) // Iterate the public subnets for (let subnet of vpc.publicSubnets) { } // Iterate the private subnets for (let subnet of vpc.privateSubnets) { }

Extends:

VpcNetworkRef

Implements:

@aws-cdk/cdk.ITaggable

Parameters:
DEFAULT_CIDR_RANGE

The default CIDR range used when creating VPCs. This can be overridden using VpcNetworkProps when creating a VPCNetwork resource. e.g. new VpcResource(this, { cidr: ‘192.168.0.0./16’ })

Type:string (readonly) (static)
DEFAULT_SUBNETS

The default subnet configuration 1 Public and 1 Private subnet per AZ evenly split

Type:SubnetConfiguration[] (readonly) (static)
availabilityZones

Implements @aws-cdk/aws-ec2.VpcNetworkRef.availabilityZones()

AZs for this VPC

Type:string[] (readonly)
cidr
Type:string (readonly)
isolatedSubnets

Implements @aws-cdk/aws-ec2.VpcNetworkRef.isolatedSubnets()

List of isolated subnets in this VPC

Type:VpcSubnetRef[] (readonly)
privateSubnets

Implements @aws-cdk/aws-ec2.VpcNetworkRef.privateSubnets()

List of private subnets in this VPC

Type:VpcSubnetRef[] (readonly)
publicSubnets

Implements @aws-cdk/aws-ec2.VpcNetworkRef.publicSubnets()

List of public subnets in this VPC

Type:VpcSubnetRef[] (readonly)
tags

Implements @aws-cdk/cdk.ITaggable.tags()

Manage tags for this construct and children

Type:@aws-cdk/cdk.TagManager (readonly)
vpcId

Implements @aws-cdk/aws-ec2.VpcNetworkRef.vpcId()

Identifier for this VPC

Type:string (readonly)
export() → @aws-cdk/aws-ec2.VpcNetworkRefProps

Inherited from @aws-cdk/aws-ec2.VpcNetworkRef

Export this VPC from the stack

Return type:VpcNetworkRefProps
isPublicSubnet(subnet) → boolean

Inherited from @aws-cdk/aws-ec2.VpcNetworkRef

Return whether the given subnet is one of this VPC’s public subnets. The subnet must literally be one of the subnet object obtained from this VPC. A subnet that merely represents the same subnet will never return true.

Parameters:subnet (VpcSubnetRef) –
Return type:boolean
subnets([placement]) → @aws-cdk/aws-ec2.VpcSubnetRef[]

Inherited from @aws-cdk/aws-ec2.VpcNetworkRef

Return the subnets appropriate for the placement strategy

Parameters:placement (VpcPlacementStrategy or undefined) –
Return type:VpcSubnetRef[]
dependencyElements

Inherited from @aws-cdk/aws-ec2.VpcNetworkRef

Parts of the VPC that constitute full construction

Type:@aws-cdk/cdk.IDependable[] (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)

VpcNetworkProps (interface)

class @aws-cdk/aws-ec2.VpcNetworkProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VpcNetworkProps;
// VpcNetworkProps is an interface
import { VpcNetworkProps } from '@aws-cdk/aws-ec2';

VpcNetworkProps allows you to specify configuration options for a VPC

cidr

The CIDR range to use for the VPC (e.g. ‘10.0.0.0/16’). Should be a minimum of /28 and maximum size of /16. The range will be split evenly into two subnets per Availability Zone (one public, one private).

Type:string or undefined (abstract)
defaultInstanceTenancy

The default tenancy of instances launched into the VPC. By default, instances will be launched with default (shared) tenancy. By setting this to dedicated tenancy, instances will be launched on hardware dedicated to a single AWS customer, unless specifically specified at instance launch time. Please note, not all instance types are usable with Dedicated tenancy.

Type:DefaultInstanceTenancy or undefined (abstract)
enableDnsHostnames

Indicates whether the instances launched in the VPC get public DNS hostnames. If this attribute is true, instances in the VPC get public DNS hostnames, but only if the enableDnsSupport attribute is also set to true.

Type:boolean or undefined (abstract)
enableDnsSupport

Indicates whether the DNS resolution is supported for the VPC. If this attribute is false, the Amazon-provided DNS server in the VPC that resolves public DNS hostnames to IP addresses is not enabled. If this attribute is true, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC IPv4 network range plus two will succeed.

Type:boolean or undefined (abstract)
maxAZs

Define the maximum number of AZs to use in this region If the region has more AZs than you want to use (for example, because of EIP limits), pick a lower number here. The AZs will be sorted and picked from the start of the list.

Type:number or undefined (abstract)
natGatewayPlacement

Configures the subnets which will have NAT Gateways You can pick a specific group of subnets by specifying the group name; the picked subnets must be public subnets.

Type:VpcPlacementStrategy or undefined (abstract)
natGateways

The number of NAT Gateways to create. For example, if set this to 1 and your subnet configuration is for 3 Public subnets then only one of the Public subnets will have a gateway and all Private subnets will route to this NAT Gateway.

Type:number or undefined (abstract)
subnetConfiguration

Configure the subnets to build for each AZ The subnets are constructed in the context of the VPC so you only need specify the configuration. The VPC details (VPC ID, specific CIDR, specific AZ will be calculated during creation) For example if you want 1 public subnet, 1 private subnet, and 1 isolated subnet in each AZ provide the following: subnetConfiguration: [ { cidrMask: 24, name: ‘ingress’, subnetType: SubnetType.Public, }, { cidrMask: 24, name: ‘application’, subnetType: SubnetType.Private, }, { cidrMask: 28, name: ‘rds’, subnetType: SubnetType.Isolated, } ] cidrMask is optional and if not provided the IP space in the VPC will be evenly divided between the requested subnets.

Type:SubnetConfiguration[] or undefined (abstract)
tags

The AWS resource tags to associate with the VPC.

Type:string => string or undefined (abstract)

VpcNetworkRef

class @aws-cdk/aws-ec2.VpcNetworkRef(parent, id)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VpcNetworkRef;
const { VpcNetworkRef } = require('@aws-cdk/aws-ec2');
import { VpcNetworkRef } from '@aws-cdk/aws-ec2';

A new or imported VPC

Extends:

@aws-cdk/cdk.Construct

Implements:

@aws-cdk/cdk.IDependable

Abstract:

Yes

Parameters:
static import(parent, name, props) → @aws-cdk/aws-ec2.VpcNetworkRef

Import an exported VPC

Parameters:
Return type:

VpcNetworkRef

export() → @aws-cdk/aws-ec2.VpcNetworkRefProps

Export this VPC from the stack

Return type:VpcNetworkRefProps
isPublicSubnet(subnet) → boolean

Return whether the given subnet is one of this VPC’s public subnets. The subnet must literally be one of the subnet object obtained from this VPC. A subnet that merely represents the same subnet will never return true.

Parameters:subnet (VpcSubnetRef) –
Return type:boolean
subnets([placement]) → @aws-cdk/aws-ec2.VpcSubnetRef[]

Return the subnets appropriate for the placement strategy

Parameters:placement (VpcPlacementStrategy or undefined) –
Return type:VpcSubnetRef[]
availabilityZones

AZs for this VPC

Type:string[] (readonly) (abstract)
dependencyElements

Implements @aws-cdk/cdk.IDependable.dependencyElements()

Parts of the VPC that constitute full construction

Type:@aws-cdk/cdk.IDependable[] (readonly)
isolatedSubnets

List of isolated subnets in this VPC

Type:VpcSubnetRef[] (readonly) (abstract)
privateSubnets

List of private subnets in this VPC

Type:VpcSubnetRef[] (readonly) (abstract)
publicSubnets

List of public subnets in this VPC

Type:VpcSubnetRef[] (readonly) (abstract)
vpcId

Identifier for this VPC

Type:string (readonly) (abstract)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)

VpcNetworkRefProps (interface)

class @aws-cdk/aws-ec2.VpcNetworkRefProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VpcNetworkRefProps;
// VpcNetworkRefProps is an interface
import { VpcNetworkRefProps } from '@aws-cdk/aws-ec2';

Properties that reference an external VpcNetwork

availabilityZones

List of availability zones for the subnets in this VPC.

Type:string[] (abstract)
vpcId

VPC’s identifier

Type:string (abstract)
isolatedSubnetIds

List of isolated subnet IDs Must be undefined or match the availability zones in length and order.

Type:string[] or undefined (abstract)
isolatedSubnetNames

List of names for the isolated subnets Must be undefined or have a name for every isolated subnet group.

Type:string[] or undefined (abstract)
privateSubnetIds

List of private subnet IDs Must be undefined or match the availability zones in length and order.

Type:string[] or undefined (abstract)
privateSubnetNames

List of names for the private subnets Must be undefined or have a name for every private subnet group.

Type:string[] or undefined (abstract)
publicSubnetIds

List of public subnet IDs Must be undefined or match the availability zones in length and order.

Type:string[] or undefined (abstract)
publicSubnetNames

List of names for the public subnets Must be undefined or have a name for every public subnet group.

Type:string[] or undefined (abstract)

VpcPlacementStrategy (interface)

class @aws-cdk/aws-ec2.VpcPlacementStrategy

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VpcPlacementStrategy;
// VpcPlacementStrategy is an interface
import { VpcPlacementStrategy } from '@aws-cdk/aws-ec2';

Customize how instances are placed inside a VPC Constructs that allow customization of VPC placement use parameters of this type to provide placement settings. By default, the instances are placed in the private subnets.

subnetName

Place the instances in the subnets with the given name (This is the name supplied in subnetConfiguration). At most one of subnetsToUse and subnetName can be supplied.

Type:string or undefined (abstract)
subnetsToUse

Place the instances in the subnets of the given type At most one of subnetsToUse and subnetName can be supplied.

Type:SubnetType or undefined (abstract)

VpcPrivateSubnet

class @aws-cdk/aws-ec2.VpcPrivateSubnet(parent, name, props)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VpcPrivateSubnet;
const { VpcPrivateSubnet } = require('@aws-cdk/aws-ec2');
import { VpcPrivateSubnet } from '@aws-cdk/aws-ec2';

Represents a private VPC subnet resource

Extends:

VpcSubnet

Parameters:
addDefaultNatRouteEntry(natGatewayId)

Adds an entry to this subnets route table that points to the passed NATGatwayId

Parameters:natGatewayId (string) –
addDefaultRouteToIGW(gatewayId)

Inherited from @aws-cdk/aws-ec2.VpcSubnet

Protected method

Parameters:gatewayId (string) –
addDefaultRouteToNAT(natGatewayId)

Inherited from @aws-cdk/aws-ec2.VpcSubnet

Protected method

Parameters:natGatewayId (string) –
availabilityZone

Inherited from @aws-cdk/aws-ec2.VpcSubnet

The Availability Zone the subnet is located in

Type:string (readonly)
subnetId

Inherited from @aws-cdk/aws-ec2.VpcSubnet

The subnetId for this particular subnet

Type:string (readonly)
tags

Inherited from @aws-cdk/aws-ec2.VpcSubnet

Manage tags for Construct and propagate to children

Type:@aws-cdk/cdk.TagManager (readonly)
dependencyElements

Inherited from @aws-cdk/aws-ec2.VpcSubnetRef

Parts of this VPC subnet

Type:@aws-cdk/cdk.IDependable[] (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)

VpcPublicSubnet

class @aws-cdk/aws-ec2.VpcPublicSubnet(parent, name, props)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VpcPublicSubnet;
const { VpcPublicSubnet } = require('@aws-cdk/aws-ec2');
import { VpcPublicSubnet } from '@aws-cdk/aws-ec2';

Represents a public VPC subnet resource

Extends:

VpcSubnet

Parameters:
addDefaultIGWRouteEntry(gatewayId)

Create a default route that points to a passed IGW

Parameters:gatewayId (string) –
addNatGateway() → string

Creates a new managed NAT gateway attached to this public subnet. Also adds the EIP for the managed NAT.

Returns:A ref to the the NAT Gateway ID
Return type:string
addDefaultRouteToIGW(gatewayId)

Inherited from @aws-cdk/aws-ec2.VpcSubnet

Protected method

Parameters:gatewayId (string) –
addDefaultRouteToNAT(natGatewayId)

Inherited from @aws-cdk/aws-ec2.VpcSubnet

Protected method

Parameters:natGatewayId (string) –
availabilityZone

Inherited from @aws-cdk/aws-ec2.VpcSubnet

The Availability Zone the subnet is located in

Type:string (readonly)
subnetId

Inherited from @aws-cdk/aws-ec2.VpcSubnet

The subnetId for this particular subnet

Type:string (readonly)
tags

Inherited from @aws-cdk/aws-ec2.VpcSubnet

Manage tags for Construct and propagate to children

Type:@aws-cdk/cdk.TagManager (readonly)
dependencyElements

Inherited from @aws-cdk/aws-ec2.VpcSubnetRef

Parts of this VPC subnet

Type:@aws-cdk/cdk.IDependable[] (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)

VpcSubnet

class @aws-cdk/aws-ec2.VpcSubnet(parent, name, props)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VpcSubnet;
const { VpcSubnet } = require('@aws-cdk/aws-ec2');
import { VpcSubnet } from '@aws-cdk/aws-ec2';

Represents a new VPC subnet resource

Extends:

VpcSubnetRef

Implements:

@aws-cdk/cdk.ITaggable

Parameters:
addDefaultRouteToIGW(gatewayId)

Protected method

Parameters:gatewayId (string) –
addDefaultRouteToNAT(natGatewayId)

Protected method

Parameters:natGatewayId (string) –
availabilityZone

Implements @aws-cdk/aws-ec2.VpcSubnetRef.availabilityZone()

The Availability Zone the subnet is located in

Type:string (readonly)
subnetId

Implements @aws-cdk/aws-ec2.VpcSubnetRef.subnetId()

The subnetId for this particular subnet

Type:string (readonly)
tags

Implements @aws-cdk/cdk.ITaggable.tags()

Manage tags for Construct and propagate to children

Type:@aws-cdk/cdk.TagManager (readonly)
dependencyElements

Inherited from @aws-cdk/aws-ec2.VpcSubnetRef

Parts of this VPC subnet

Type:@aws-cdk/cdk.IDependable[] (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)

VpcSubnetProps (interface)

class @aws-cdk/aws-ec2.VpcSubnetProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VpcSubnetProps;
// VpcSubnetProps is an interface
import { VpcSubnetProps } from '@aws-cdk/aws-ec2';

Specify configuration parameters for a VPC subnet

availabilityZone

The availability zone for the subnet

Type:string (abstract)
cidrBlock

The CIDR notation for this subnet

Type:string (abstract)
vpcId

The VPC which this subnet is part of

Type:string (abstract)
mapPublicIpOnLaunch

Controls if a public IP is associated to an instance at launch Defaults to true in Subnet.Public, false in Subnet.Private or Subnet.Isolated.

Type:boolean or undefined (abstract)
tags

The AWS resource tags to associate with the Subnet

Type:string => string or undefined (abstract)

VpcSubnetRef

class @aws-cdk/aws-ec2.VpcSubnetRef(parent, id)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VpcSubnetRef;
const { VpcSubnetRef } = require('@aws-cdk/aws-ec2');
import { VpcSubnetRef } from '@aws-cdk/aws-ec2';

A new or imported VPC Subnet

Extends:

@aws-cdk/cdk.Construct

Implements:

@aws-cdk/cdk.IDependable

Abstract:

Yes

Parameters:
static import(parent, name, props) → @aws-cdk/aws-ec2.VpcSubnetRef
Parameters:
Return type:

VpcSubnetRef

availabilityZone

The Availability Zone the subnet is located in

Type:string (readonly) (abstract)
dependencyElements

Implements @aws-cdk/cdk.IDependable.dependencyElements()

Parts of this VPC subnet

Type:@aws-cdk/cdk.IDependable[] (readonly)
subnetId

The subnetId for this particular subnet

Type:string (readonly) (abstract)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)

VpcSubnetRefProps (interface)

class @aws-cdk/aws-ec2.VpcSubnetRefProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VpcSubnetRefProps;
// VpcSubnetRefProps is an interface
import { VpcSubnetRefProps } from '@aws-cdk/aws-ec2';
availabilityZone

The Availability Zone the subnet is located in

Type:string (abstract)
subnetId

The subnetId for this particular subnet

Type:string (abstract)

WindowsImage

class @aws-cdk/aws-ec2.WindowsImage(version)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.WindowsImage;
const { WindowsImage } = require('@aws-cdk/aws-ec2');
import { WindowsImage } from '@aws-cdk/aws-ec2';

Select the latest version of the indicated Windows version The AMI ID is selected using the values published to the SSM parameter store. https://aws.amazon.com/blogs/mt/query-for-the-latest-windows-ami-using-systems-manager-parameter-store/

Implements:IMachineImageSource
Parameters:version (WindowsVersion) –
getImage(parent) → @aws-cdk/aws-ec2.MachineImage

Implements @aws-cdk/aws-ec2.IMachineImageSource.getImage()

Return the image to use in the given context

Parameters:parent (@aws-cdk/cdk.Construct) –
Return type:MachineImage
version
Type:WindowsVersion (readonly)

WindowsOS

class @aws-cdk/aws-ec2.WindowsOS

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.WindowsOS;
const { WindowsOS } = require('@aws-cdk/aws-ec2');
import { WindowsOS } from '@aws-cdk/aws-ec2';

OS features specialized for Windows

Extends:OperatingSystem
createUserData(scripts) → string

Implements @aws-cdk/aws-ec2.OperatingSystem.createUserData()

Parameters:scripts (string[]) –
Return type:string
type

Implements @aws-cdk/aws-ec2.OperatingSystem.type()

Type:OperatingSystemType (readonly)

WindowsVersion (enum)

class @aws-cdk/aws-ec2.WindowsVersion

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.WindowsVersion;
const { WindowsVersion } = require('@aws-cdk/aws-ec2');
import { WindowsVersion } from '@aws-cdk/aws-ec2';

The Windows version to use for the WindowsImage

WindowsServer2016TurksihFullBase
WindowsServer2016SwedishFullBase
WindowsServer2016SpanishFullBase
WindowsServer2016RussianFullBase
WindowsServer2016PortuguesePortugalFullBase
WindowsServer2016PortugueseBrazilFullBase
WindowsServer2016PolishFullBase
WindowsServer2016KoreanFullSQL2016Base
WindowsServer2016KoreanFullBase
WindowsServer2016JapaneseFullSQL2016Web
WindowsServer2016JapaneseFullSQL2016Standard
WindowsServer2016JapaneseFullSQL2016Express
WindowsServer2016JapaneseFullSQL2016Enterprise
WindowsServer2016JapaneseFullBase
WindowsServer2016ItalianFullBase
WindowsServer2016HungarianFullBase
WindowsServer2016GermanFullBase
WindowsServer2016FrenchFullBase
WindowsServer2016EnglishNanoBase
WindowsServer2016EnglishFullSQL2017Web
WindowsServer2016EnglishFullSQL2017Standard
WindowsServer2016EnglishFullSQL2017Express
WindowsServer2016EnglishFullSQL2017Enterprise

cloudformation

CustomerGatewayResource

class @aws-cdk/aws-ec2.cloudformation.CustomerGatewayResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.CustomerGatewayResource;
const { cloudformation.CustomerGatewayResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.CustomerGatewayResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this CustomerGatewayResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (CustomerGatewayResourceProps) – the properties of this CustomerGatewayResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
customerGatewayName
Type:string (readonly)
propertyOverrides
Type:CustomerGatewayResourceProps (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

CustomerGatewayResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.CustomerGatewayResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.CustomerGatewayResourceProps;
// cloudformation.CustomerGatewayResourceProps is an interface
import { cloudformation.CustomerGatewayResourceProps } from '@aws-cdk/aws-ec2';
bgpAsn

AWS::EC2::CustomerGateway.BgpAsn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customer-gateway.html#cfn-ec2-customergateway-bgpasn

Type:number or @aws-cdk/cdk.Token (abstract)
ipAddress

AWS::EC2::CustomerGateway.IpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customer-gateway.html#cfn-ec2-customergateway-ipaddress

Type:string or @aws-cdk/cdk.Token (abstract)
type

AWS::EC2::CustomerGateway.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customer-gateway.html#cfn-ec2-customergateway-type

Type:string or @aws-cdk/cdk.Token (abstract)
tags

AWS::EC2::CustomerGateway.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customer-gateway.html#cfn-ec2-customergateway-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.Tag)[] or undefined (abstract)

DHCPOptionsResource

class @aws-cdk/aws-ec2.cloudformation.DHCPOptionsResource(parent, name[, properties])

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.DHCPOptionsResource;
const { cloudformation.DHCPOptionsResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.DHCPOptionsResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this DHCPOptionsResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (DHCPOptionsResourceProps or undefined) – the properties of this DHCPOptionsResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
dhcpOptionsName
Type:string (readonly)
propertyOverrides
Type:DHCPOptionsResourceProps (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

DHCPOptionsResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.DHCPOptionsResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.DHCPOptionsResourceProps;
// cloudformation.DHCPOptionsResourceProps is an interface
import { cloudformation.DHCPOptionsResourceProps } from '@aws-cdk/aws-ec2';
domainName

AWS::EC2::DHCPOptions.DomainName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcp-options.html#cfn-ec2-dhcpoptions-domainname

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
domainNameServers

AWS::EC2::DHCPOptions.DomainNameServers http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcp-options.html#cfn-ec2-dhcpoptions-domainnameservers

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] or undefined (abstract)
netbiosNameServers

AWS::EC2::DHCPOptions.NetbiosNameServers http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcp-options.html#cfn-ec2-dhcpoptions-netbiosnameservers

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] or undefined (abstract)
netbiosNodeType

AWS::EC2::DHCPOptions.NetbiosNodeType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcp-options.html#cfn-ec2-dhcpoptions-netbiosnodetype

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
ntpServers

AWS::EC2::DHCPOptions.NtpServers http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcp-options.html#cfn-ec2-dhcpoptions-ntpservers

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] or undefined (abstract)
tags

AWS::EC2::DHCPOptions.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcp-options.html#cfn-ec2-dhcpoptions-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.Tag)[] or undefined (abstract)

EIPAssociationResource

class @aws-cdk/aws-ec2.cloudformation.EIPAssociationResource(parent, name[, properties])

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.EIPAssociationResource;
const { cloudformation.EIPAssociationResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.EIPAssociationResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this EIPAssociationResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (EIPAssociationResourceProps or undefined) – the properties of this EIPAssociationResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
eipAssociationName
Type:string (readonly)
propertyOverrides
Type:EIPAssociationResourceProps (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

EIPAssociationResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.EIPAssociationResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.EIPAssociationResourceProps;
// cloudformation.EIPAssociationResourceProps is an interface
import { cloudformation.EIPAssociationResourceProps } from '@aws-cdk/aws-ec2';
allocationId

AWS::EC2::EIPAssociation.AllocationId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html#cfn-ec2-eipassociation-allocationid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
eip

AWS::EC2::EIPAssociation.EIP http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html#cfn-ec2-eipassociation-eip

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
instanceId

AWS::EC2::EIPAssociation.InstanceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html#cfn-ec2-eipassociation-instanceid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
networkInterfaceId

AWS::EC2::EIPAssociation.NetworkInterfaceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html#cfn-ec2-eipassociation-networkinterfaceid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
privateIpAddress

AWS::EC2::EIPAssociation.PrivateIpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html#cfn-ec2-eipassociation-PrivateIpAddress

Type:string or @aws-cdk/cdk.Token or undefined (abstract)

EIPResource

class @aws-cdk/aws-ec2.cloudformation.EIPResource(parent, name[, properties])

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.EIPResource;
const { cloudformation.EIPResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.EIPResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this EIPResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (EIPResourceProps or undefined) – the properties of this EIPResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
eipAllocationId
Type:string (readonly)
eipIp
Type:string (readonly)
propertyOverrides
Type:EIPResourceProps (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

EIPResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.EIPResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.EIPResourceProps;
// cloudformation.EIPResourceProps is an interface
import { cloudformation.EIPResourceProps } from '@aws-cdk/aws-ec2';
domain

AWS::EC2::EIP.Domain http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip.html#cfn-ec2-eip-domain

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
instanceId

AWS::EC2::EIP.InstanceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip.html#cfn-ec2-eip-instanceid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)

EgressOnlyInternetGatewayResource

class @aws-cdk/aws-ec2.cloudformation.EgressOnlyInternetGatewayResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.EgressOnlyInternetGatewayResource;
const { cloudformation.EgressOnlyInternetGatewayResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.EgressOnlyInternetGatewayResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
egressOnlyInternetGatewayId
Type:string (readonly)
propertyOverrides
Type:EgressOnlyInternetGatewayResourceProps (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

EgressOnlyInternetGatewayResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.EgressOnlyInternetGatewayResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.EgressOnlyInternetGatewayResourceProps;
// cloudformation.EgressOnlyInternetGatewayResourceProps is an interface
import { cloudformation.EgressOnlyInternetGatewayResourceProps } from '@aws-cdk/aws-ec2';
vpcId

AWS::EC2::EgressOnlyInternetGateway.VpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-egressonlyinternetgateway.html#cfn-ec2-egressonlyinternetgateway-vpcid

Type:string or @aws-cdk/cdk.Token (abstract)

FlowLogResource

class @aws-cdk/aws-ec2.cloudformation.FlowLogResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.FlowLogResource;
const { cloudformation.FlowLogResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.FlowLogResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this FlowLogResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (FlowLogResourceProps) – the properties of this FlowLogResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
flowLogId
Type:string (readonly)
propertyOverrides
Type:FlowLogResourceProps (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

FlowLogResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.FlowLogResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.FlowLogResourceProps;
// cloudformation.FlowLogResourceProps is an interface
import { cloudformation.FlowLogResourceProps } from '@aws-cdk/aws-ec2';
resourceId

AWS::EC2::FlowLog.ResourceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-resourceid

Type:string or @aws-cdk/cdk.Token (abstract)
resourceType

AWS::EC2::FlowLog.ResourceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-resourcetype

Type:string or @aws-cdk/cdk.Token (abstract)
trafficType

AWS::EC2::FlowLog.TrafficType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-traffictype

Type:string or @aws-cdk/cdk.Token (abstract)
deliverLogsPermissionArn

AWS::EC2::FlowLog.DeliverLogsPermissionArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-deliverlogspermissionarn

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
logDestination

AWS::EC2::FlowLog.LogDestination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-logdestination

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
logDestinationType

AWS::EC2::FlowLog.LogDestinationType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-logdestinationtype

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
logGroupName

AWS::EC2::FlowLog.LogGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-loggroupname

Type:string or @aws-cdk/cdk.Token or undefined (abstract)

HostResource

class @aws-cdk/aws-ec2.cloudformation.HostResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.HostResource;
const { cloudformation.HostResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.HostResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this HostResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (HostResourceProps) – the properties of this HostResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
hostId
Type:string (readonly)
propertyOverrides
Type:HostResourceProps (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

HostResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.HostResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.HostResourceProps;
// cloudformation.HostResourceProps is an interface
import { cloudformation.HostResourceProps } from '@aws-cdk/aws-ec2';
availabilityZone

AWS::EC2::Host.AvailabilityZone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-availabilityzone

Type:string or @aws-cdk/cdk.Token (abstract)
instanceType

AWS::EC2::Host.InstanceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-instancetype

Type:string or @aws-cdk/cdk.Token (abstract)
autoPlacement

AWS::EC2::Host.AutoPlacement http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-autoplacement

Type:string or @aws-cdk/cdk.Token or undefined (abstract)

InstanceResource

class @aws-cdk/aws-ec2.cloudformation.InstanceResource(parent, name[, properties])

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource;
const { cloudformation.InstanceResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.InstanceResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this InstanceResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (InstanceResourceProps or undefined) – the properties of this InstanceResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
instanceAvailabilityZone
Type:string (readonly)
instanceId
Type:string (readonly)
instancePrivateDnsName
Type:string (readonly)
instancePrivateIp
Type:string (readonly)
instancePublicDnsName
Type:string (readonly)
instancePublicIp
Type:string (readonly)
propertyOverrides
Type:InstanceResourceProps (readonly)
class AssociationParameterProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.AssociationParameterProperty;
// cloudformation.InstanceResource.AssociationParameterProperty is an interface
import { cloudformation.InstanceResource.AssociationParameterProperty } from '@aws-cdk/aws-ec2';
key

InstanceResource.AssociationParameterProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociations-associationparameters.html#cfn-ec2-instance-ssmassociations-associationparameters-key

Type:string or @aws-cdk/cdk.Token (abstract)
value

InstanceResource.AssociationParameterProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociations-associationparameters.html#cfn-ec2-instance-ssmassociations-associationparameters-value

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (abstract)
class BlockDeviceMappingProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.BlockDeviceMappingProperty;
// cloudformation.InstanceResource.BlockDeviceMappingProperty is an interface
import { cloudformation.InstanceResource.BlockDeviceMappingProperty } from '@aws-cdk/aws-ec2';
deviceName

InstanceResource.BlockDeviceMappingProperty.DeviceName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-mapping.html#cfn-ec2-blockdev-mapping-devicename

Type:string or @aws-cdk/cdk.Token (abstract)
ebs

InstanceResource.BlockDeviceMappingProperty.Ebs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-mapping.html#cfn-ec2-blockdev-mapping-ebs

Type:@aws-cdk/cdk.Token or EbsProperty or undefined (abstract)
noDevice

InstanceResource.BlockDeviceMappingProperty.NoDevice http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-mapping.html#cfn-ec2-blockdev-mapping-nodevice

Type:@aws-cdk/cdk.Token or NoDeviceProperty or undefined (abstract)
virtualName

InstanceResource.BlockDeviceMappingProperty.VirtualName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-mapping.html#cfn-ec2-blockdev-mapping-virtualname

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
class CreditSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.CreditSpecificationProperty;
// cloudformation.InstanceResource.CreditSpecificationProperty is an interface
import { cloudformation.InstanceResource.CreditSpecificationProperty } from '@aws-cdk/aws-ec2';
cpuCredits

InstanceResource.CreditSpecificationProperty.CPUCredits http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-creditspecification.html#cfn-ec2-instance-creditspecification-cpucredits

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
class EbsProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.EbsProperty;
// cloudformation.InstanceResource.EbsProperty is an interface
import { cloudformation.InstanceResource.EbsProperty } from '@aws-cdk/aws-ec2';
deleteOnTermination

InstanceResource.EbsProperty.DeleteOnTermination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-deleteontermination

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
encrypted

InstanceResource.EbsProperty.Encrypted http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-encrypted

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
iops

InstanceResource.EbsProperty.Iops http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-iops

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
snapshotId

InstanceResource.EbsProperty.SnapshotId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-snapshotid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
volumeSize

InstanceResource.EbsProperty.VolumeSize http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-volumesize

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
volumeType

InstanceResource.EbsProperty.VolumeType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-volumetype

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
class ElasticGpuSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.ElasticGpuSpecificationProperty;
// cloudformation.InstanceResource.ElasticGpuSpecificationProperty is an interface
import { cloudformation.InstanceResource.ElasticGpuSpecificationProperty } from '@aws-cdk/aws-ec2';
type

InstanceResource.ElasticGpuSpecificationProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-elasticgpuspecification.html#cfn-ec2-instance-elasticgpuspecification-type

Type:string or @aws-cdk/cdk.Token (abstract)
class InstanceIpv6AddressProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.InstanceIpv6AddressProperty;
// cloudformation.InstanceResource.InstanceIpv6AddressProperty is an interface
import { cloudformation.InstanceResource.InstanceIpv6AddressProperty } from '@aws-cdk/aws-ec2';
ipv6Address

InstanceResource.InstanceIpv6AddressProperty.Ipv6Address http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-instanceipv6address.html#cfn-ec2-instance-instanceipv6address-ipv6address

Type:string or @aws-cdk/cdk.Token (abstract)
class LaunchTemplateSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.LaunchTemplateSpecificationProperty;
// cloudformation.InstanceResource.LaunchTemplateSpecificationProperty is an interface
import { cloudformation.InstanceResource.LaunchTemplateSpecificationProperty } from '@aws-cdk/aws-ec2';
version

InstanceResource.LaunchTemplateSpecificationProperty.Version http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-launchtemplatespecification.html#cfn-ec2-instance-launchtemplatespecification-version

Type:string or @aws-cdk/cdk.Token (abstract)
launchTemplateId

InstanceResource.LaunchTemplateSpecificationProperty.LaunchTemplateId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-launchtemplatespecification.html#cfn-ec2-instance-launchtemplatespecification-launchtemplateid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
launchTemplateName

InstanceResource.LaunchTemplateSpecificationProperty.LaunchTemplateName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-launchtemplatespecification.html#cfn-ec2-instance-launchtemplatespecification-launchtemplatename

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
class NetworkInterfaceProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.NetworkInterfaceProperty;
// cloudformation.InstanceResource.NetworkInterfaceProperty is an interface
import { cloudformation.InstanceResource.NetworkInterfaceProperty } from '@aws-cdk/aws-ec2';
deviceIndex

InstanceResource.NetworkInterfaceProperty.DeviceIndex http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-deviceindex

Type:string or @aws-cdk/cdk.Token (abstract)
associatePublicIpAddress

InstanceResource.NetworkInterfaceProperty.AssociatePublicIpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-associatepubip

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
deleteOnTermination

InstanceResource.NetworkInterfaceProperty.DeleteOnTermination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-delete

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
description

InstanceResource.NetworkInterfaceProperty.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-description

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
groupSet

InstanceResource.NetworkInterfaceProperty.GroupSet http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-groupset

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] or undefined (abstract)
ipv6AddressCount

InstanceResource.NetworkInterfaceProperty.Ipv6AddressCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#cfn-ec2-instance-networkinterface-ipv6addresscount

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
ipv6Addresses

InstanceResource.NetworkInterfaceProperty.Ipv6Addresses http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#cfn-ec2-instance-networkinterface-ipv6addresses

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or InstanceIpv6AddressProperty)[] or undefined (abstract)
networkInterfaceId

InstanceResource.NetworkInterfaceProperty.NetworkInterfaceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-network-iface

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
privateIpAddress

InstanceResource.NetworkInterfaceProperty.PrivateIpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-privateipaddress

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
privateIpAddresses

InstanceResource.NetworkInterfaceProperty.PrivateIpAddresses http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-privateipaddresses

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or PrivateIpAddressSpecificationProperty)[] or undefined (abstract)
secondaryPrivateIpAddressCount

InstanceResource.NetworkInterfaceProperty.SecondaryPrivateIpAddressCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-secondprivateip

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
subnetId

InstanceResource.NetworkInterfaceProperty.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-subnetid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
class NoDeviceProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.NoDeviceProperty;
// cloudformation.InstanceResource.NoDeviceProperty is an interface
import { cloudformation.InstanceResource.NoDeviceProperty } from '@aws-cdk/aws-ec2';
class PrivateIpAddressSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.PrivateIpAddressSpecificationProperty;
// cloudformation.InstanceResource.PrivateIpAddressSpecificationProperty is an interface
import { cloudformation.InstanceResource.PrivateIpAddressSpecificationProperty } from '@aws-cdk/aws-ec2';
primary

InstanceResource.PrivateIpAddressSpecificationProperty.Primary http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-interface-privateipspec.html#cfn-ec2-networkinterface-privateipspecification-primary

Type:boolean or @aws-cdk/cdk.Token (abstract)
privateIpAddress

InstanceResource.PrivateIpAddressSpecificationProperty.PrivateIpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-interface-privateipspec.html#cfn-ec2-networkinterface-privateipspecification-privateipaddress

Type:string or @aws-cdk/cdk.Token (abstract)
class SsmAssociationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.SsmAssociationProperty;
// cloudformation.InstanceResource.SsmAssociationProperty is an interface
import { cloudformation.InstanceResource.SsmAssociationProperty } from '@aws-cdk/aws-ec2';
documentName

InstanceResource.SsmAssociationProperty.DocumentName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociations.html#cfn-ec2-instance-ssmassociations-documentname

Type:string or @aws-cdk/cdk.Token (abstract)
associationParameters

InstanceResource.SsmAssociationProperty.AssociationParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociations.html#cfn-ec2-instance-ssmassociations-associationparameters

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or AssociationParameterProperty)[] or undefined (abstract)
class VolumeProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.VolumeProperty;
// cloudformation.InstanceResource.VolumeProperty is an interface
import { cloudformation.InstanceResource.VolumeProperty } from '@aws-cdk/aws-ec2';
device

InstanceResource.VolumeProperty.Device http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-mount-point.html#cfn-ec2-mountpoint-device

Type:string or @aws-cdk/cdk.Token (abstract)
volumeId

InstanceResource.VolumeProperty.VolumeId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-mount-point.html#cfn-ec2-mountpoint-volumeid

Type:string or @aws-cdk/cdk.Token (abstract)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

InstanceResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.InstanceResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResourceProps;
// cloudformation.InstanceResourceProps is an interface
import { cloudformation.InstanceResourceProps } from '@aws-cdk/aws-ec2';
additionalInfo

AWS::EC2::Instance.AdditionalInfo http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-additionalinfo

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
affinity

AWS::EC2::Instance.Affinity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-affinity

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
availabilityZone

AWS::EC2::Instance.AvailabilityZone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-availabilityzone

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
blockDeviceMappings

AWS::EC2::Instance.BlockDeviceMappings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-blockdevicemappings

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or BlockDeviceMappingProperty)[] or undefined (abstract)
creditSpecification

AWS::EC2::Instance.CreditSpecification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-creditspecification

Type:@aws-cdk/cdk.Token or CreditSpecificationProperty or undefined (abstract)
disableApiTermination

AWS::EC2::Instance.DisableApiTermination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-disableapitermination

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
ebsOptimized

AWS::EC2::Instance.EbsOptimized http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-ebsoptimized

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
elasticGpuSpecifications

AWS::EC2::Instance.ElasticGpuSpecifications http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-elasticgpuspecifications

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or ElasticGpuSpecificationProperty)[] or undefined (abstract)
hostId

AWS::EC2::Instance.HostId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-hostid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
iamInstanceProfile

AWS::EC2::Instance.IamInstanceProfile http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-iaminstanceprofile

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
imageId

AWS::EC2::Instance.ImageId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-imageid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
instanceInitiatedShutdownBehavior

AWS::EC2::Instance.InstanceInitiatedShutdownBehavior http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-instanceinitiatedshutdownbehavior

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
instanceType

AWS::EC2::Instance.InstanceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-instancetype

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
ipv6AddressCount

AWS::EC2::Instance.Ipv6AddressCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-ipv6addresscount

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
ipv6Addresses

AWS::EC2::Instance.Ipv6Addresses http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-ipv6addresses

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or InstanceIpv6AddressProperty)[] or undefined (abstract)
kernelId

AWS::EC2::Instance.KernelId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-kernelid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
keyName

AWS::EC2::Instance.KeyName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-keyname

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
launchTemplate

AWS::EC2::Instance.LaunchTemplate http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-launchtemplate

Type:@aws-cdk/cdk.Token or LaunchTemplateSpecificationProperty or undefined (abstract)
monitoring

AWS::EC2::Instance.Monitoring http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-monitoring

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
networkInterfaces

AWS::EC2::Instance.NetworkInterfaces http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-networkinterfaces

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or NetworkInterfaceProperty)[] or undefined (abstract)
placementGroupName

AWS::EC2::Instance.PlacementGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-placementgroupname

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
privateIpAddress

AWS::EC2::Instance.PrivateIpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-privateipaddress

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
ramdiskId

AWS::EC2::Instance.RamdiskId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-ramdiskid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
securityGroupIds

AWS::EC2::Instance.SecurityGroupIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-securitygroupids

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] or undefined (abstract)
securityGroups

AWS::EC2::Instance.SecurityGroups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-securitygroups

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] or undefined (abstract)
sourceDestCheck

AWS::EC2::Instance.SourceDestCheck http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-sourcedestcheck

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
ssmAssociations

AWS::EC2::Instance.SsmAssociations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-ssmassociations

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or SsmAssociationProperty)[] or undefined (abstract)
subnetId

AWS::EC2::Instance.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-subnetid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
tags

AWS::EC2::Instance.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.Tag)[] or undefined (abstract)
tenancy

AWS::EC2::Instance.Tenancy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-tenancy

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
userData

AWS::EC2::Instance.UserData http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-userdata

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
volumes

AWS::EC2::Instance.Volumes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-volumes

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or VolumeProperty)[] or undefined (abstract)

InternetGatewayResource

class @aws-cdk/aws-ec2.cloudformation.InternetGatewayResource(parent, name[, properties])

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InternetGatewayResource;
const { cloudformation.InternetGatewayResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.InternetGatewayResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this InternetGatewayResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (InternetGatewayResourceProps or undefined) – the properties of this InternetGatewayResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
internetGatewayName
Type:string (readonly)
propertyOverrides
Type:InternetGatewayResourceProps (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

InternetGatewayResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.InternetGatewayResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InternetGatewayResourceProps;
// cloudformation.InternetGatewayResourceProps is an interface
import { cloudformation.InternetGatewayResourceProps } from '@aws-cdk/aws-ec2';
tags

AWS::EC2::InternetGateway.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-internetgateway.html#cfn-ec2-internetgateway-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.Tag)[] or undefined (abstract)

LaunchTemplateResource

class @aws-cdk/aws-ec2.cloudformation.LaunchTemplateResource(parent, name[, properties])

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource;
const { cloudformation.LaunchTemplateResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.LaunchTemplateResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this LaunchTemplateResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (LaunchTemplateResourceProps or undefined) – the properties of this LaunchTemplateResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
launchTemplateDefaultVersionNumber
Type:string (readonly)
launchTemplateId
Type:string (readonly)
launchTemplateLatestVersionNumber
Type:string (readonly)
propertyOverrides
Type:LaunchTemplateResourceProps (readonly)
class BlockDeviceMappingProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.BlockDeviceMappingProperty;
// cloudformation.LaunchTemplateResource.BlockDeviceMappingProperty is an interface
import { cloudformation.LaunchTemplateResource.BlockDeviceMappingProperty } from '@aws-cdk/aws-ec2';
deviceName

LaunchTemplateResource.BlockDeviceMappingProperty.DeviceName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-devicename

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
ebs

LaunchTemplateResource.BlockDeviceMappingProperty.Ebs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs

Type:@aws-cdk/cdk.Token or EbsProperty or undefined (abstract)
noDevice

LaunchTemplateResource.BlockDeviceMappingProperty.NoDevice http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-nodevice

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
virtualName

LaunchTemplateResource.BlockDeviceMappingProperty.VirtualName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-virtualname

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
class CreditSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.CreditSpecificationProperty;
// cloudformation.LaunchTemplateResource.CreditSpecificationProperty is an interface
import { cloudformation.LaunchTemplateResource.CreditSpecificationProperty } from '@aws-cdk/aws-ec2';
cpuCredits

LaunchTemplateResource.CreditSpecificationProperty.CpuCredits http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-creditspecification.html#cfn-ec2-launchtemplate-launchtemplatedata-creditspecification-cpucredits

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
class EbsProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.EbsProperty;
// cloudformation.LaunchTemplateResource.EbsProperty is an interface
import { cloudformation.LaunchTemplateResource.EbsProperty } from '@aws-cdk/aws-ec2';
deleteOnTermination

LaunchTemplateResource.EbsProperty.DeleteOnTermination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-deleteontermination

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
encrypted

LaunchTemplateResource.EbsProperty.Encrypted http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-encrypted

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
iops

LaunchTemplateResource.EbsProperty.Iops http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-iops

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
kmsKeyId

LaunchTemplateResource.EbsProperty.KmsKeyId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-kmskeyid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
snapshotId

LaunchTemplateResource.EbsProperty.SnapshotId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-snapshotid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
volumeSize

LaunchTemplateResource.EbsProperty.VolumeSize http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-volumesize

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
volumeType

LaunchTemplateResource.EbsProperty.VolumeType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-volumetype

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
class ElasticGpuSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.ElasticGpuSpecificationProperty;
// cloudformation.LaunchTemplateResource.ElasticGpuSpecificationProperty is an interface
import { cloudformation.LaunchTemplateResource.ElasticGpuSpecificationProperty } from '@aws-cdk/aws-ec2';
type

LaunchTemplateResource.ElasticGpuSpecificationProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-elasticgpuspecification.html#cfn-ec2-launchtemplate-elasticgpuspecification-type

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
class IamInstanceProfileProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.IamInstanceProfileProperty;
// cloudformation.LaunchTemplateResource.IamInstanceProfileProperty is an interface
import { cloudformation.LaunchTemplateResource.IamInstanceProfileProperty } from '@aws-cdk/aws-ec2';
arn

LaunchTemplateResource.IamInstanceProfileProperty.Arn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-iaminstanceprofile.html#cfn-ec2-launchtemplate-launchtemplatedata-iaminstanceprofile-arn

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
name

LaunchTemplateResource.IamInstanceProfileProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-iaminstanceprofile.html#cfn-ec2-launchtemplate-launchtemplatedata-iaminstanceprofile-name

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
class InstanceMarketOptionsProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.InstanceMarketOptionsProperty;
// cloudformation.LaunchTemplateResource.InstanceMarketOptionsProperty is an interface
import { cloudformation.LaunchTemplateResource.InstanceMarketOptionsProperty } from '@aws-cdk/aws-ec2';
marketType

LaunchTemplateResource.InstanceMarketOptionsProperty.MarketType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-markettype

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
spotOptions

LaunchTemplateResource.InstanceMarketOptionsProperty.SpotOptions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions

Type:@aws-cdk/cdk.Token or SpotOptionsProperty or undefined (abstract)
class Ipv6AddProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.Ipv6AddProperty;
// cloudformation.LaunchTemplateResource.Ipv6AddProperty is an interface
import { cloudformation.LaunchTemplateResource.Ipv6AddProperty } from '@aws-cdk/aws-ec2';
ipv6Address

LaunchTemplateResource.Ipv6AddProperty.Ipv6Address http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ipv6add.html#cfn-ec2-launchtemplate-ipv6add-ipv6address

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
class LaunchTemplateDataProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.LaunchTemplateDataProperty;
// cloudformation.LaunchTemplateResource.LaunchTemplateDataProperty is an interface
import { cloudformation.LaunchTemplateResource.LaunchTemplateDataProperty } from '@aws-cdk/aws-ec2';
blockDeviceMappings

LaunchTemplateResource.LaunchTemplateDataProperty.BlockDeviceMappings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-blockdevicemappings

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or BlockDeviceMappingProperty)[] or undefined (abstract)
creditSpecification

LaunchTemplateResource.LaunchTemplateDataProperty.CreditSpecification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-creditspecification

Type:@aws-cdk/cdk.Token or CreditSpecificationProperty or undefined (abstract)
disableApiTermination

LaunchTemplateResource.LaunchTemplateDataProperty.DisableApiTermination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-disableapitermination

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
ebsOptimized

LaunchTemplateResource.LaunchTemplateDataProperty.EbsOptimized http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-ebsoptimized

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
elasticGpuSpecifications

LaunchTemplateResource.LaunchTemplateDataProperty.ElasticGpuSpecifications http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-elasticgpuspecifications

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or ElasticGpuSpecificationProperty)[] or undefined (abstract)
iamInstanceProfile

LaunchTemplateResource.LaunchTemplateDataProperty.IamInstanceProfile http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-iaminstanceprofile

Type:@aws-cdk/cdk.Token or IamInstanceProfileProperty or undefined (abstract)
imageId

LaunchTemplateResource.LaunchTemplateDataProperty.ImageId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-imageid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
instanceInitiatedShutdownBehavior

LaunchTemplateResource.LaunchTemplateDataProperty.InstanceInitiatedShutdownBehavior http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-instanceinitiatedshutdownbehavior

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
instanceMarketOptions

LaunchTemplateResource.LaunchTemplateDataProperty.InstanceMarketOptions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions

Type:@aws-cdk/cdk.Token or InstanceMarketOptionsProperty or undefined (abstract)
instanceType

LaunchTemplateResource.LaunchTemplateDataProperty.InstanceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-instancetype

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
kernelId

LaunchTemplateResource.LaunchTemplateDataProperty.KernelId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-kernelid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
keyName

LaunchTemplateResource.LaunchTemplateDataProperty.KeyName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-keyname

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
monitoring

LaunchTemplateResource.LaunchTemplateDataProperty.Monitoring http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-monitoring

Type:@aws-cdk/cdk.Token or MonitoringProperty or undefined (abstract)
networkInterfaces

LaunchTemplateResource.LaunchTemplateDataProperty.NetworkInterfaces http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-networkinterfaces

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or NetworkInterfaceProperty)[] or undefined (abstract)
placement

LaunchTemplateResource.LaunchTemplateDataProperty.Placement http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-placement

Type:@aws-cdk/cdk.Token or PlacementProperty or undefined (abstract)
ramDiskId

LaunchTemplateResource.LaunchTemplateDataProperty.RamDiskId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-ramdiskid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
securityGroupIds

LaunchTemplateResource.LaunchTemplateDataProperty.SecurityGroupIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-securitygroupids

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] or undefined (abstract)
securityGroups

LaunchTemplateResource.LaunchTemplateDataProperty.SecurityGroups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-securitygroups

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] or undefined (abstract)
tagSpecifications

LaunchTemplateResource.LaunchTemplateDataProperty.TagSpecifications http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or TagSpecificationProperty)[] or undefined (abstract)
userData

LaunchTemplateResource.LaunchTemplateDataProperty.UserData http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-userdata

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
class MonitoringProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.MonitoringProperty;
// cloudformation.LaunchTemplateResource.MonitoringProperty is an interface
import { cloudformation.LaunchTemplateResource.MonitoringProperty } from '@aws-cdk/aws-ec2';
enabled

LaunchTemplateResource.MonitoringProperty.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-monitoring.html#cfn-ec2-launchtemplate-launchtemplatedata-monitoring-enabled

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
class NetworkInterfaceProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.NetworkInterfaceProperty;
// cloudformation.LaunchTemplateResource.NetworkInterfaceProperty is an interface
import { cloudformation.LaunchTemplateResource.NetworkInterfaceProperty } from '@aws-cdk/aws-ec2';
associatePublicIpAddress

LaunchTemplateResource.NetworkInterfaceProperty.AssociatePublicIpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-associatepublicipaddress

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
deleteOnTermination

LaunchTemplateResource.NetworkInterfaceProperty.DeleteOnTermination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-deleteontermination

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
description

LaunchTemplateResource.NetworkInterfaceProperty.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-description

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
deviceIndex

LaunchTemplateResource.NetworkInterfaceProperty.DeviceIndex http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-deviceindex

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
groups

LaunchTemplateResource.NetworkInterfaceProperty.Groups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-groups

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] or undefined (abstract)
ipv6AddressCount

LaunchTemplateResource.NetworkInterfaceProperty.Ipv6AddressCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-ipv6addresscount

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
ipv6Addresses

LaunchTemplateResource.NetworkInterfaceProperty.Ipv6Addresses http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-ipv6addresses

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or Ipv6AddProperty)[] or undefined (abstract)
networkInterfaceId

LaunchTemplateResource.NetworkInterfaceProperty.NetworkInterfaceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-networkinterfaceid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
privateIpAddress

LaunchTemplateResource.NetworkInterfaceProperty.PrivateIpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-privateipaddress

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
privateIpAddresses

LaunchTemplateResource.NetworkInterfaceProperty.PrivateIpAddresses http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-privateipaddresses

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or PrivateIpAddProperty)[] or undefined (abstract)
secondaryPrivateIpAddressCount

LaunchTemplateResource.NetworkInterfaceProperty.SecondaryPrivateIpAddressCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-secondaryprivateipaddresscount

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
subnetId

LaunchTemplateResource.NetworkInterfaceProperty.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-subnetid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
class PlacementProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.PlacementProperty;
// cloudformation.LaunchTemplateResource.PlacementProperty is an interface
import { cloudformation.LaunchTemplateResource.PlacementProperty } from '@aws-cdk/aws-ec2';
affinity

LaunchTemplateResource.PlacementProperty.Affinity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-affinity

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
availabilityZone

LaunchTemplateResource.PlacementProperty.AvailabilityZone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-availabilityzone

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
groupName

LaunchTemplateResource.PlacementProperty.GroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-groupname

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
hostId

LaunchTemplateResource.PlacementProperty.HostId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-hostid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
tenancy

LaunchTemplateResource.PlacementProperty.Tenancy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-tenancy

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
class PrivateIpAddProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.PrivateIpAddProperty;
// cloudformation.LaunchTemplateResource.PrivateIpAddProperty is an interface
import { cloudformation.LaunchTemplateResource.PrivateIpAddProperty } from '@aws-cdk/aws-ec2';
primary

LaunchTemplateResource.PrivateIpAddProperty.Primary http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-privateipadd.html#cfn-ec2-launchtemplate-privateipadd-primary

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
privateIpAddress

LaunchTemplateResource.PrivateIpAddProperty.PrivateIpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-privateipadd.html#cfn-ec2-launchtemplate-privateipadd-privateipaddress

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
class SpotOptionsProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.SpotOptionsProperty;
// cloudformation.LaunchTemplateResource.SpotOptionsProperty is an interface
import { cloudformation.LaunchTemplateResource.SpotOptionsProperty } from '@aws-cdk/aws-ec2';
instanceInterruptionBehavior

LaunchTemplateResource.SpotOptionsProperty.InstanceInterruptionBehavior http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions-instanceinterruptionbehavior

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
maxPrice

LaunchTemplateResource.SpotOptionsProperty.MaxPrice http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions-maxprice

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
spotInstanceType

LaunchTemplateResource.SpotOptionsProperty.SpotInstanceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions-spotinstancetype

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
class TagSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.TagSpecificationProperty;
// cloudformation.LaunchTemplateResource.TagSpecificationProperty is an interface
import { cloudformation.LaunchTemplateResource.TagSpecificationProperty } from '@aws-cdk/aws-ec2';
resourceType

LaunchTemplateResource.TagSpecificationProperty.ResourceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html#cfn-ec2-launchtemplate-tagspecification-resourcetype

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
tags

LaunchTemplateResource.TagSpecificationProperty.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html#cfn-ec2-launchtemplate-tagspecification-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.Tag)[] or undefined (abstract)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

LaunchTemplateResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.LaunchTemplateResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResourceProps;
// cloudformation.LaunchTemplateResourceProps is an interface
import { cloudformation.LaunchTemplateResourceProps } from '@aws-cdk/aws-ec2';
launchTemplateData

AWS::EC2::LaunchTemplate.LaunchTemplateData http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-launchtemplatedata

Type:@aws-cdk/cdk.Token or LaunchTemplateDataProperty or undefined (abstract)
launchTemplateName

AWS::EC2::LaunchTemplate.LaunchTemplateName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-launchtemplatename

Type:string or @aws-cdk/cdk.Token or undefined (abstract)

NatGatewayResource

class @aws-cdk/aws-ec2.cloudformation.NatGatewayResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NatGatewayResource;
const { cloudformation.NatGatewayResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.NatGatewayResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this NatGatewayResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (NatGatewayResourceProps) – the properties of this NatGatewayResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
natGatewayId
Type:string (readonly)
propertyOverrides
Type:NatGatewayResourceProps (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

NatGatewayResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.NatGatewayResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NatGatewayResourceProps;
// cloudformation.NatGatewayResourceProps is an interface
import { cloudformation.NatGatewayResourceProps } from '@aws-cdk/aws-ec2';
allocationId

AWS::EC2::NatGateway.AllocationId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-allocationid

Type:string or @aws-cdk/cdk.Token (abstract)
subnetId

AWS::EC2::NatGateway.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-subnetid

Type:string or @aws-cdk/cdk.Token (abstract)
tags

AWS::EC2::NatGateway.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.Tag)[] or undefined (abstract)

NetworkAclEntryResource

class @aws-cdk/aws-ec2.cloudformation.NetworkAclEntryResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkAclEntryResource;
const { cloudformation.NetworkAclEntryResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.NetworkAclEntryResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this NetworkAclEntryResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (NetworkAclEntryResourceProps) – the properties of this NetworkAclEntryResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
networkAclEntryName
Type:string (readonly)
propertyOverrides
Type:NetworkAclEntryResourceProps (readonly)
class IcmpProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkAclEntryResource.IcmpProperty;
// cloudformation.NetworkAclEntryResource.IcmpProperty is an interface
import { cloudformation.NetworkAclEntryResource.IcmpProperty } from '@aws-cdk/aws-ec2';
code

NetworkAclEntryResource.IcmpProperty.Code http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-icmp.html#cfn-ec2-networkaclentry-icmp-code

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
type

NetworkAclEntryResource.IcmpProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-icmp.html#cfn-ec2-networkaclentry-icmp-type

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
class PortRangeProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkAclEntryResource.PortRangeProperty;
// cloudformation.NetworkAclEntryResource.PortRangeProperty is an interface
import { cloudformation.NetworkAclEntryResource.PortRangeProperty } from '@aws-cdk/aws-ec2';
from

NetworkAclEntryResource.PortRangeProperty.From http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-portrange.html#cfn-ec2-networkaclentry-portrange-from

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
to

NetworkAclEntryResource.PortRangeProperty.To http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-portrange.html#cfn-ec2-networkaclentry-portrange-to

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

NetworkAclEntryResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.NetworkAclEntryResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkAclEntryResourceProps;
// cloudformation.NetworkAclEntryResourceProps is an interface
import { cloudformation.NetworkAclEntryResourceProps } from '@aws-cdk/aws-ec2';
cidrBlock

AWS::EC2::NetworkAclEntry.CidrBlock http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-cidrblock

Type:string or @aws-cdk/cdk.Token (abstract)
networkAclId

AWS::EC2::NetworkAclEntry.NetworkAclId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-networkaclid

Type:string or @aws-cdk/cdk.Token (abstract)
protocol

AWS::EC2::NetworkAclEntry.Protocol http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-protocol

Type:number or @aws-cdk/cdk.Token (abstract)
ruleAction

AWS::EC2::NetworkAclEntry.RuleAction http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-ruleaction

Type:string or @aws-cdk/cdk.Token (abstract)
ruleNumber

AWS::EC2::NetworkAclEntry.RuleNumber http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-rulenumber

Type:number or @aws-cdk/cdk.Token (abstract)
egress

AWS::EC2::NetworkAclEntry.Egress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-egress

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
icmp

AWS::EC2::NetworkAclEntry.Icmp http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-icmp

Type:@aws-cdk/cdk.Token or IcmpProperty or undefined (abstract)
ipv6CidrBlock

AWS::EC2::NetworkAclEntry.Ipv6CidrBlock http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-ipv6cidrblock

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
portRange

AWS::EC2::NetworkAclEntry.PortRange http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-portrange

Type:@aws-cdk/cdk.Token or PortRangeProperty or undefined (abstract)

NetworkAclResource

class @aws-cdk/aws-ec2.cloudformation.NetworkAclResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkAclResource;
const { cloudformation.NetworkAclResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.NetworkAclResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this NetworkAclResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (NetworkAclResourceProps) – the properties of this NetworkAclResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
networkAclName
Type:string (readonly)
propertyOverrides
Type:NetworkAclResourceProps (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

NetworkAclResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.NetworkAclResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkAclResourceProps;
// cloudformation.NetworkAclResourceProps is an interface
import { cloudformation.NetworkAclResourceProps } from '@aws-cdk/aws-ec2';
vpcId

AWS::EC2::NetworkAcl.VpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl.html#cfn-ec2-networkacl-vpcid

Type:string or @aws-cdk/cdk.Token (abstract)
tags

AWS::EC2::NetworkAcl.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl.html#cfn-ec2-networkacl-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.Tag)[] or undefined (abstract)

NetworkInterfaceAttachmentResource

class @aws-cdk/aws-ec2.cloudformation.NetworkInterfaceAttachmentResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkInterfaceAttachmentResource;
const { cloudformation.NetworkInterfaceAttachmentResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.NetworkInterfaceAttachmentResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
networkInterfaceAttachmentName
Type:string (readonly)
propertyOverrides
Type:NetworkInterfaceAttachmentResourceProps (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

NetworkInterfaceAttachmentResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.NetworkInterfaceAttachmentResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkInterfaceAttachmentResourceProps;
// cloudformation.NetworkInterfaceAttachmentResourceProps is an interface
import { cloudformation.NetworkInterfaceAttachmentResourceProps } from '@aws-cdk/aws-ec2';
deviceIndex

AWS::EC2::NetworkInterfaceAttachment.DeviceIndex http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface-attachment.html#cfn-ec2-network-interface-attachment-deviceindex

Type:string or @aws-cdk/cdk.Token (abstract)
instanceId

AWS::EC2::NetworkInterfaceAttachment.InstanceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface-attachment.html#cfn-ec2-network-interface-attachment-instanceid

Type:string or @aws-cdk/cdk.Token (abstract)
networkInterfaceId

AWS::EC2::NetworkInterfaceAttachment.NetworkInterfaceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface-attachment.html#cfn-ec2-network-interface-attachment-networkinterfaceid

Type:string or @aws-cdk/cdk.Token (abstract)
deleteOnTermination

AWS::EC2::NetworkInterfaceAttachment.DeleteOnTermination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface-attachment.html#cfn-ec2-network-interface-attachment-deleteonterm

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)

NetworkInterfacePermissionResource

class @aws-cdk/aws-ec2.cloudformation.NetworkInterfacePermissionResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkInterfacePermissionResource;
const { cloudformation.NetworkInterfacePermissionResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.NetworkInterfacePermissionResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
networkInterfacePermissionId
Type:string (readonly)
propertyOverrides
Type:NetworkInterfacePermissionResourceProps (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

NetworkInterfacePermissionResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.NetworkInterfacePermissionResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkInterfacePermissionResourceProps;
// cloudformation.NetworkInterfacePermissionResourceProps is an interface
import { cloudformation.NetworkInterfacePermissionResourceProps } from '@aws-cdk/aws-ec2';
awsAccountId

AWS::EC2::NetworkInterfacePermission.AwsAccountId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html#cfn-ec2-networkinterfacepermission-awsaccountid

Type:string or @aws-cdk/cdk.Token (abstract)
networkInterfaceId

AWS::EC2::NetworkInterfacePermission.NetworkInterfaceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html#cfn-ec2-networkinterfacepermission-networkinterfaceid

Type:string or @aws-cdk/cdk.Token (abstract)
permission

AWS::EC2::NetworkInterfacePermission.Permission http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html#cfn-ec2-networkinterfacepermission-permission

Type:string or @aws-cdk/cdk.Token (abstract)

NetworkInterfaceResource

class @aws-cdk/aws-ec2.cloudformation.NetworkInterfaceResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkInterfaceResource;
const { cloudformation.NetworkInterfaceResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.NetworkInterfaceResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this NetworkInterfaceResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (NetworkInterfaceResourceProps) – the properties of this NetworkInterfaceResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
networkInterfaceName
Type:string (readonly)
networkInterfacePrimaryPrivateIpAddress
Type:string (readonly)
networkInterfaceSecondaryPrivateIpAddresses
Type:NetworkInterfaceSecondaryPrivateIpAddresses (readonly)
propertyOverrides
Type:NetworkInterfaceResourceProps (readonly)
class InstanceIpv6AddressProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkInterfaceResource.InstanceIpv6AddressProperty;
// cloudformation.NetworkInterfaceResource.InstanceIpv6AddressProperty is an interface
import { cloudformation.NetworkInterfaceResource.InstanceIpv6AddressProperty } from '@aws-cdk/aws-ec2';
ipv6Address

NetworkInterfaceResource.InstanceIpv6AddressProperty.Ipv6Address http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-instanceipv6address.html#cfn-ec2-networkinterface-instanceipv6address-ipv6address

Type:string or @aws-cdk/cdk.Token (abstract)
class PrivateIpAddressSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkInterfaceResource.PrivateIpAddressSpecificationProperty;
// cloudformation.NetworkInterfaceResource.PrivateIpAddressSpecificationProperty is an interface
import { cloudformation.NetworkInterfaceResource.PrivateIpAddressSpecificationProperty } from '@aws-cdk/aws-ec2';
primary

NetworkInterfaceResource.PrivateIpAddressSpecificationProperty.Primary http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-interface-privateipspec.html#cfn-ec2-networkinterface-privateipspecification-primary

Type:boolean or @aws-cdk/cdk.Token (abstract)
privateIpAddress

NetworkInterfaceResource.PrivateIpAddressSpecificationProperty.PrivateIpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-interface-privateipspec.html#cfn-ec2-networkinterface-privateipspecification-privateipaddress

Type:string or @aws-cdk/cdk.Token (abstract)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

NetworkInterfaceResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.NetworkInterfaceResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkInterfaceResourceProps;
// cloudformation.NetworkInterfaceResourceProps is an interface
import { cloudformation.NetworkInterfaceResourceProps } from '@aws-cdk/aws-ec2';
subnetId

AWS::EC2::NetworkInterface.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-awsec2networkinterface-subnetid

Type:string or @aws-cdk/cdk.Token (abstract)
description

AWS::EC2::NetworkInterface.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-awsec2networkinterface-description

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
groupSet

AWS::EC2::NetworkInterface.GroupSet http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-awsec2networkinterface-groupset

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] or undefined (abstract)
interfaceType

AWS::EC2::NetworkInterface.InterfaceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-ec2-networkinterface-interfacetype

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
ipv6AddressCount

AWS::EC2::NetworkInterface.Ipv6AddressCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-ec2-networkinterface-ipv6addresscount

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
ipv6Addresses

AWS::EC2::NetworkInterface.Ipv6Addresses http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-ec2-networkinterface-ipv6addresses

Type:@aws-cdk/cdk.Token or InstanceIpv6AddressProperty or undefined (abstract)
privateIpAddress

AWS::EC2::NetworkInterface.PrivateIpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-awsec2networkinterface-privateipaddress

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
privateIpAddresses

AWS::EC2::NetworkInterface.PrivateIpAddresses http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-awsec2networkinterface-privateipaddresses

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or PrivateIpAddressSpecificationProperty)[] or undefined (abstract)
secondaryPrivateIpAddressCount

AWS::EC2::NetworkInterface.SecondaryPrivateIpAddressCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-awsec2networkinterface-secondaryprivateipcount

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
sourceDestCheck

AWS::EC2::NetworkInterface.SourceDestCheck http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-awsec2networkinterface-sourcedestcheck

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
tags

AWS::EC2::NetworkInterface.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-awsec2networkinterface-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.Tag)[] or undefined (abstract)

PlacementGroupResource

class @aws-cdk/aws-ec2.cloudformation.PlacementGroupResource(parent, name[, properties])

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.PlacementGroupResource;
const { cloudformation.PlacementGroupResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.PlacementGroupResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this PlacementGroupResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (PlacementGroupResourceProps or undefined) – the properties of this PlacementGroupResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
placementGroupName
Type:string (readonly)
propertyOverrides
Type:PlacementGroupResourceProps (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

PlacementGroupResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.PlacementGroupResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.PlacementGroupResourceProps;
// cloudformation.PlacementGroupResourceProps is an interface
import { cloudformation.PlacementGroupResourceProps } from '@aws-cdk/aws-ec2';
strategy

AWS::EC2::PlacementGroup.Strategy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html#cfn-ec2-placementgroup-strategy

Type:string or @aws-cdk/cdk.Token or undefined (abstract)

RouteResource

class @aws-cdk/aws-ec2.cloudformation.RouteResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.RouteResource;
const { cloudformation.RouteResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.RouteResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this RouteResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (RouteResourceProps) – the properties of this RouteResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:RouteResourceProps (readonly)
routeName
Type:string (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

RouteResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.RouteResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.RouteResourceProps;
// cloudformation.RouteResourceProps is an interface
import { cloudformation.RouteResourceProps } from '@aws-cdk/aws-ec2';
routeTableId

AWS::EC2::Route.RouteTableId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-routetableid

Type:string or @aws-cdk/cdk.Token (abstract)
destinationCidrBlock

AWS::EC2::Route.DestinationCidrBlock http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-destinationcidrblock

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
destinationIpv6CidrBlock

AWS::EC2::Route.DestinationIpv6CidrBlock http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-destinationipv6cidrblock

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
egressOnlyInternetGatewayId

AWS::EC2::Route.EgressOnlyInternetGatewayId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-egressonlyinternetgatewayid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
gatewayId

AWS::EC2::Route.GatewayId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-gatewayid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
instanceId

AWS::EC2::Route.InstanceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-instanceid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
natGatewayId

AWS::EC2::Route.NatGatewayId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-natgatewayid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
networkInterfaceId

AWS::EC2::Route.NetworkInterfaceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-networkinterfaceid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
vpcPeeringConnectionId

AWS::EC2::Route.VpcPeeringConnectionId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-vpcpeeringconnectionid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)

RouteTableResource

class @aws-cdk/aws-ec2.cloudformation.RouteTableResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.RouteTableResource;
const { cloudformation.RouteTableResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.RouteTableResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this RouteTableResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (RouteTableResourceProps) – the properties of this RouteTableResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:RouteTableResourceProps (readonly)
routeTableId
Type:string (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

RouteTableResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.RouteTableResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.RouteTableResourceProps;
// cloudformation.RouteTableResourceProps is an interface
import { cloudformation.RouteTableResourceProps } from '@aws-cdk/aws-ec2';
vpcId

AWS::EC2::RouteTable.VpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route-table.html#cfn-ec2-routetable-vpcid

Type:string or @aws-cdk/cdk.Token (abstract)
tags

AWS::EC2::RouteTable.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route-table.html#cfn-ec2-routetable-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.Tag)[] or undefined (abstract)

SecurityGroupEgressResource

class @aws-cdk/aws-ec2.cloudformation.SecurityGroupEgressResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SecurityGroupEgressResource;
const { cloudformation.SecurityGroupEgressResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.SecurityGroupEgressResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this SecurityGroupEgressResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (SecurityGroupEgressResourceProps) – the properties of this SecurityGroupEgressResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:SecurityGroupEgressResourceProps (readonly)
securityGroupEgressId
Type:string (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

SecurityGroupEgressResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.SecurityGroupEgressResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SecurityGroupEgressResourceProps;
// cloudformation.SecurityGroupEgressResourceProps is an interface
import { cloudformation.SecurityGroupEgressResourceProps } from '@aws-cdk/aws-ec2';
groupId

AWS::EC2::SecurityGroupEgress.GroupId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-groupid

Type:string or @aws-cdk/cdk.Token (abstract)
ipProtocol

AWS::EC2::SecurityGroupEgress.IpProtocol http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-ipprotocol

Type:string or @aws-cdk/cdk.Token (abstract)
cidrIp

AWS::EC2::SecurityGroupEgress.CidrIp http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-cidrip

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
cidrIpv6

AWS::EC2::SecurityGroupEgress.CidrIpv6 http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-cidripv6

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
description

AWS::EC2::SecurityGroupEgress.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-description

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
destinationPrefixListId

AWS::EC2::SecurityGroupEgress.DestinationPrefixListId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-destinationprefixlistid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
destinationSecurityGroupId

AWS::EC2::SecurityGroupEgress.DestinationSecurityGroupId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-destinationsecuritygroupid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
fromPort

AWS::EC2::SecurityGroupEgress.FromPort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-fromport

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
toPort

AWS::EC2::SecurityGroupEgress.ToPort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-toport

Type:number or @aws-cdk/cdk.Token or undefined (abstract)

SecurityGroupIngressResource

class @aws-cdk/aws-ec2.cloudformation.SecurityGroupIngressResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SecurityGroupIngressResource;
const { cloudformation.SecurityGroupIngressResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.SecurityGroupIngressResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:SecurityGroupIngressResourceProps (readonly)
securityGroupIngressId
Type:string (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

SecurityGroupIngressResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.SecurityGroupIngressResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SecurityGroupIngressResourceProps;
// cloudformation.SecurityGroupIngressResourceProps is an interface
import { cloudformation.SecurityGroupIngressResourceProps } from '@aws-cdk/aws-ec2';
ipProtocol

AWS::EC2::SecurityGroupIngress.IpProtocol http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-ipprotocol

Type:string or @aws-cdk/cdk.Token (abstract)
cidrIp

AWS::EC2::SecurityGroupIngress.CidrIp http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-cidrip

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
cidrIpv6

AWS::EC2::SecurityGroupIngress.CidrIpv6 http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-cidripv6

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
description

AWS::EC2::SecurityGroupIngress.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-description

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
fromPort

AWS::EC2::SecurityGroupIngress.FromPort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-fromport

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
groupId

AWS::EC2::SecurityGroupIngress.GroupId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-groupid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
groupName

AWS::EC2::SecurityGroupIngress.GroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-groupname

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
sourceSecurityGroupId

AWS::EC2::SecurityGroupIngress.SourceSecurityGroupId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-sourcesecuritygroupid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
sourceSecurityGroupName

AWS::EC2::SecurityGroupIngress.SourceSecurityGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-sourcesecuritygroupname

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
sourceSecurityGroupOwnerId

AWS::EC2::SecurityGroupIngress.SourceSecurityGroupOwnerId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-sourcesecuritygroupownerid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
toPort

AWS::EC2::SecurityGroupIngress.ToPort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-toport

Type:number or @aws-cdk/cdk.Token or undefined (abstract)

SecurityGroupResource

class @aws-cdk/aws-ec2.cloudformation.SecurityGroupResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SecurityGroupResource;
const { cloudformation.SecurityGroupResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.SecurityGroupResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this SecurityGroupResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (SecurityGroupResourceProps) – the properties of this SecurityGroupResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:SecurityGroupResourceProps (readonly)
securityGroupId
Type:string (readonly)
securityGroupName
Type:string (readonly)
securityGroupVpcId
Type:string (readonly)
class EgressProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SecurityGroupResource.EgressProperty;
// cloudformation.SecurityGroupResource.EgressProperty is an interface
import { cloudformation.SecurityGroupResource.EgressProperty } from '@aws-cdk/aws-ec2';
ipProtocol

SecurityGroupResource.EgressProperty.IpProtocol http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-ipprotocol

Type:string or @aws-cdk/cdk.Token (abstract)
cidrIp

SecurityGroupResource.EgressProperty.CidrIp http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-cidrip

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
cidrIpv6

SecurityGroupResource.EgressProperty.CidrIpv6 http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-cidripv6

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
description

SecurityGroupResource.EgressProperty.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-description

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
destinationPrefixListId

SecurityGroupResource.EgressProperty.DestinationPrefixListId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-destinationprefixlistid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
destinationSecurityGroupId

SecurityGroupResource.EgressProperty.DestinationSecurityGroupId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-destsecgroupid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
fromPort

SecurityGroupResource.EgressProperty.FromPort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-fromport

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
toPort

SecurityGroupResource.EgressProperty.ToPort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-toport

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
class IngressProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SecurityGroupResource.IngressProperty;
// cloudformation.SecurityGroupResource.IngressProperty is an interface
import { cloudformation.SecurityGroupResource.IngressProperty } from '@aws-cdk/aws-ec2';
ipProtocol

SecurityGroupResource.IngressProperty.IpProtocol http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-ipprotocol

Type:string or @aws-cdk/cdk.Token (abstract)
cidrIp

SecurityGroupResource.IngressProperty.CidrIp http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-cidrip

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
cidrIpv6

SecurityGroupResource.IngressProperty.CidrIpv6 http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-cidripv6

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
description

SecurityGroupResource.IngressProperty.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-description

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
fromPort

SecurityGroupResource.IngressProperty.FromPort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-fromport

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
sourceSecurityGroupId

SecurityGroupResource.IngressProperty.SourceSecurityGroupId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-sourcesecuritygroupid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
sourceSecurityGroupName

SecurityGroupResource.IngressProperty.SourceSecurityGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-sourcesecuritygroupname

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
sourceSecurityGroupOwnerId

SecurityGroupResource.IngressProperty.SourceSecurityGroupOwnerId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-sourcesecuritygroupownerid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
toPort

SecurityGroupResource.IngressProperty.ToPort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-toport

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

SecurityGroupResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.SecurityGroupResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SecurityGroupResourceProps;
// cloudformation.SecurityGroupResourceProps is an interface
import { cloudformation.SecurityGroupResourceProps } from '@aws-cdk/aws-ec2';
groupDescription

AWS::EC2::SecurityGroup.GroupDescription http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-groupdescription

Type:string or @aws-cdk/cdk.Token (abstract)
groupName

AWS::EC2::SecurityGroup.GroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-groupname

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
securityGroupEgress

AWS::EC2::SecurityGroup.SecurityGroupEgress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-securitygroupegress

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or EgressProperty)[] or undefined (abstract)
securityGroupIngress

AWS::EC2::SecurityGroup.SecurityGroupIngress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-securitygroupingress

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or IngressProperty)[] or undefined (abstract)
tags

AWS::EC2::SecurityGroup.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.Tag)[] or undefined (abstract)
vpcId

AWS::EC2::SecurityGroup.VpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-vpcid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)

SpotFleetResource

class @aws-cdk/aws-ec2.cloudformation.SpotFleetResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource;
const { cloudformation.SpotFleetResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.SpotFleetResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this SpotFleetResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (SpotFleetResourceProps) – the properties of this SpotFleetResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:SpotFleetResourceProps (readonly)
spotFleetName
Type:string (readonly)
class BlockDeviceMappingProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.BlockDeviceMappingProperty;
// cloudformation.SpotFleetResource.BlockDeviceMappingProperty is an interface
import { cloudformation.SpotFleetResource.BlockDeviceMappingProperty } from '@aws-cdk/aws-ec2';
deviceName

SpotFleetResource.BlockDeviceMappingProperty.DeviceName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings.html#cfn-ec2-spotfleet-blockdevicemapping-devicename

Type:string or @aws-cdk/cdk.Token (abstract)
ebs

SpotFleetResource.BlockDeviceMappingProperty.Ebs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings.html#cfn-ec2-spotfleet-blockdevicemapping-ebs

Type:@aws-cdk/cdk.Token or EbsBlockDeviceProperty or undefined (abstract)
noDevice

SpotFleetResource.BlockDeviceMappingProperty.NoDevice http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings.html#cfn-ec2-spotfleet-blockdevicemapping-nodevice

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
virtualName

SpotFleetResource.BlockDeviceMappingProperty.VirtualName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings.html#cfn-ec2-spotfleet-blockdevicemapping-virtualname

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
class ClassicLoadBalancerProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.ClassicLoadBalancerProperty;
// cloudformation.SpotFleetResource.ClassicLoadBalancerProperty is an interface
import { cloudformation.SpotFleetResource.ClassicLoadBalancerProperty } from '@aws-cdk/aws-ec2';
name

SpotFleetResource.ClassicLoadBalancerProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-classicloadbalancer.html#cfn-ec2-spotfleet-classicloadbalancer-name

Type:string or @aws-cdk/cdk.Token (abstract)
class ClassicLoadBalancersConfigProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.ClassicLoadBalancersConfigProperty;
// cloudformation.SpotFleetResource.ClassicLoadBalancersConfigProperty is an interface
import { cloudformation.SpotFleetResource.ClassicLoadBalancersConfigProperty } from '@aws-cdk/aws-ec2';
classicLoadBalancers

SpotFleetResource.ClassicLoadBalancersConfigProperty.ClassicLoadBalancers http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-classicloadbalancersconfig.html#cfn-ec2-spotfleet-classicloadbalancersconfig-classicloadbalancers

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or ClassicLoadBalancerProperty)[] (abstract)
class EbsBlockDeviceProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.EbsBlockDeviceProperty;
// cloudformation.SpotFleetResource.EbsBlockDeviceProperty is an interface
import { cloudformation.SpotFleetResource.EbsBlockDeviceProperty } from '@aws-cdk/aws-ec2';
deleteOnTermination

SpotFleetResource.EbsBlockDeviceProperty.DeleteOnTermination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings-ebs.html#cfn-ec2-spotfleet-ebsblockdevice-deleteontermination

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
encrypted

SpotFleetResource.EbsBlockDeviceProperty.Encrypted http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings-ebs.html#cfn-ec2-spotfleet-ebsblockdevice-encrypted

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
iops

SpotFleetResource.EbsBlockDeviceProperty.Iops http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings-ebs.html#cfn-ec2-spotfleet-ebsblockdevice-iops

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
snapshotId

SpotFleetResource.EbsBlockDeviceProperty.SnapshotId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings-ebs.html#cfn-ec2-spotfleet-ebsblockdevice-snapshotid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
volumeSize

SpotFleetResource.EbsBlockDeviceProperty.VolumeSize http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings-ebs.html#cfn-ec2-spotfleet-ebsblockdevice-volumesize

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
volumeType

SpotFleetResource.EbsBlockDeviceProperty.VolumeType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings-ebs.html#cfn-ec2-spotfleet-ebsblockdevice-volumetype

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
class FleetLaunchTemplateSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.FleetLaunchTemplateSpecificationProperty;
// cloudformation.SpotFleetResource.FleetLaunchTemplateSpecificationProperty is an interface
import { cloudformation.SpotFleetResource.FleetLaunchTemplateSpecificationProperty } from '@aws-cdk/aws-ec2';
version

SpotFleetResource.FleetLaunchTemplateSpecificationProperty.Version http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-fleetlaunchtemplatespecification.html#cfn-ec2-spotfleet-fleetlaunchtemplatespecification-version

Type:string or @aws-cdk/cdk.Token (abstract)
launchTemplateId

SpotFleetResource.FleetLaunchTemplateSpecificationProperty.LaunchTemplateId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-fleetlaunchtemplatespecification.html#cfn-ec2-spotfleet-fleetlaunchtemplatespecification-launchtemplateid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
launchTemplateName

SpotFleetResource.FleetLaunchTemplateSpecificationProperty.LaunchTemplateName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-fleetlaunchtemplatespecification.html#cfn-ec2-spotfleet-fleetlaunchtemplatespecification-launchtemplatename

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
class GroupIdentifierProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.GroupIdentifierProperty;
// cloudformation.SpotFleetResource.GroupIdentifierProperty is an interface
import { cloudformation.SpotFleetResource.GroupIdentifierProperty } from '@aws-cdk/aws-ec2';
groupId

SpotFleetResource.GroupIdentifierProperty.GroupId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-securitygroups.html#cfn-ec2-spotfleet-groupidentifier-groupid

Type:string or @aws-cdk/cdk.Token (abstract)
class IamInstanceProfileSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.IamInstanceProfileSpecificationProperty;
// cloudformation.SpotFleetResource.IamInstanceProfileSpecificationProperty is an interface
import { cloudformation.SpotFleetResource.IamInstanceProfileSpecificationProperty } from '@aws-cdk/aws-ec2';
arn

SpotFleetResource.IamInstanceProfileSpecificationProperty.Arn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-iaminstanceprofile.html#cfn-ec2-spotfleet-iaminstanceprofilespecification-arn

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
class InstanceIpv6AddressProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.InstanceIpv6AddressProperty;
// cloudformation.SpotFleetResource.InstanceIpv6AddressProperty is an interface
import { cloudformation.SpotFleetResource.InstanceIpv6AddressProperty } from '@aws-cdk/aws-ec2';
ipv6Address

SpotFleetResource.InstanceIpv6AddressProperty.Ipv6Address http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instanceipv6address.html#cfn-ec2-spotfleet-instanceipv6address-ipv6address

Type:string or @aws-cdk/cdk.Token (abstract)
class InstanceNetworkInterfaceSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty;
// cloudformation.SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty is an interface
import { cloudformation.SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty } from '@aws-cdk/aws-ec2';
associatePublicIpAddress

SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.AssociatePublicIpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-associatepublicipaddress

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
deleteOnTermination

SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.DeleteOnTermination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-deleteontermination

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
description

SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-description

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
deviceIndex

SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.DeviceIndex http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-deviceindex

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
groups

SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.Groups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-groups

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] or undefined (abstract)
ipv6AddressCount

SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.Ipv6AddressCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-ipv6addresscount

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
ipv6Addresses

SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.Ipv6Addresses http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-ipv6addresses

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or InstanceIpv6AddressProperty)[] or undefined (abstract)
networkInterfaceId

SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.NetworkInterfaceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-networkinterfaceid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
privateIpAddresses

SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.PrivateIpAddresses http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-privateipaddresses

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or PrivateIpAddressSpecificationProperty)[] or undefined (abstract)
secondaryPrivateIpAddressCount

SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.SecondaryPrivateIpAddressCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-secondaryprivateipaddresscount

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
subnetId

SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-subnetid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
class LaunchTemplateConfigProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.LaunchTemplateConfigProperty;
// cloudformation.SpotFleetResource.LaunchTemplateConfigProperty is an interface
import { cloudformation.SpotFleetResource.LaunchTemplateConfigProperty } from '@aws-cdk/aws-ec2';
launchTemplateSpecification

SpotFleetResource.LaunchTemplateConfigProperty.LaunchTemplateSpecification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateconfig.html#cfn-ec2-spotfleet-launchtemplateconfig-launchtemplatespecification

Type:@aws-cdk/cdk.Token or FleetLaunchTemplateSpecificationProperty or undefined (abstract)
overrides

SpotFleetResource.LaunchTemplateConfigProperty.Overrides http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateconfig.html#cfn-ec2-spotfleet-launchtemplateconfig-overrides

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or LaunchTemplateOverridesProperty)[] or undefined (abstract)
class LaunchTemplateOverridesProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.LaunchTemplateOverridesProperty;
// cloudformation.SpotFleetResource.LaunchTemplateOverridesProperty is an interface
import { cloudformation.SpotFleetResource.LaunchTemplateOverridesProperty } from '@aws-cdk/aws-ec2';
availabilityZone

SpotFleetResource.LaunchTemplateOverridesProperty.AvailabilityZone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-availabilityzone

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
instanceType

SpotFleetResource.LaunchTemplateOverridesProperty.InstanceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-instancetype

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
spotPrice

SpotFleetResource.LaunchTemplateOverridesProperty.SpotPrice http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-spotprice

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
subnetId

SpotFleetResource.LaunchTemplateOverridesProperty.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-subnetid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
weightedCapacity

SpotFleetResource.LaunchTemplateOverridesProperty.WeightedCapacity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-weightedcapacity

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
class LoadBalancersConfigProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.LoadBalancersConfigProperty;
// cloudformation.SpotFleetResource.LoadBalancersConfigProperty is an interface
import { cloudformation.SpotFleetResource.LoadBalancersConfigProperty } from '@aws-cdk/aws-ec2';
classicLoadBalancersConfig

SpotFleetResource.LoadBalancersConfigProperty.ClassicLoadBalancersConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-loadbalancersconfig.html#cfn-ec2-spotfleet-loadbalancersconfig-classicloadbalancersconfig

Type:@aws-cdk/cdk.Token or ClassicLoadBalancersConfigProperty or undefined (abstract)
targetGroupsConfig

SpotFleetResource.LoadBalancersConfigProperty.TargetGroupsConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-loadbalancersconfig.html#cfn-ec2-spotfleet-loadbalancersconfig-targetgroupsconfig

Type:@aws-cdk/cdk.Token or TargetGroupsConfigProperty or undefined (abstract)
class PrivateIpAddressSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.PrivateIpAddressSpecificationProperty;
// cloudformation.SpotFleetResource.PrivateIpAddressSpecificationProperty is an interface
import { cloudformation.SpotFleetResource.PrivateIpAddressSpecificationProperty } from '@aws-cdk/aws-ec2';
privateIpAddress

SpotFleetResource.PrivateIpAddressSpecificationProperty.PrivateIpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces-privateipaddresses.html#cfn-ec2-spotfleet-privateipaddressspecification-privateipaddress

Type:string or @aws-cdk/cdk.Token (abstract)
primary

SpotFleetResource.PrivateIpAddressSpecificationProperty.Primary http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces-privateipaddresses.html#cfn-ec2-spotfleet-privateipaddressspecification-primary

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
class SpotFleetLaunchSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.SpotFleetLaunchSpecificationProperty;
// cloudformation.SpotFleetResource.SpotFleetLaunchSpecificationProperty is an interface
import { cloudformation.SpotFleetResource.SpotFleetLaunchSpecificationProperty } from '@aws-cdk/aws-ec2';
imageId

SpotFleetResource.SpotFleetLaunchSpecificationProperty.ImageId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-imageid

Type:string or @aws-cdk/cdk.Token (abstract)
instanceType

SpotFleetResource.SpotFleetLaunchSpecificationProperty.InstanceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-instancetype

Type:string or @aws-cdk/cdk.Token (abstract)
blockDeviceMappings

SpotFleetResource.SpotFleetLaunchSpecificationProperty.BlockDeviceMappings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-blockdevicemappings

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or BlockDeviceMappingProperty)[] or undefined (abstract)
ebsOptimized

SpotFleetResource.SpotFleetLaunchSpecificationProperty.EbsOptimized http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-ebsoptimized

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
iamInstanceProfile

SpotFleetResource.SpotFleetLaunchSpecificationProperty.IamInstanceProfile http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-iaminstanceprofile

Type:@aws-cdk/cdk.Token or IamInstanceProfileSpecificationProperty or undefined (abstract)
kernelId

SpotFleetResource.SpotFleetLaunchSpecificationProperty.KernelId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-kernelid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
keyName

SpotFleetResource.SpotFleetLaunchSpecificationProperty.KeyName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-keyname

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
monitoring

SpotFleetResource.SpotFleetLaunchSpecificationProperty.Monitoring http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-monitoring

Type:@aws-cdk/cdk.Token or SpotFleetMonitoringProperty or undefined (abstract)
networkInterfaces

SpotFleetResource.SpotFleetLaunchSpecificationProperty.NetworkInterfaces http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-networkinterfaces

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or InstanceNetworkInterfaceSpecificationProperty)[] or undefined (abstract)
placement

SpotFleetResource.SpotFleetLaunchSpecificationProperty.Placement http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-placement

Type:@aws-cdk/cdk.Token or SpotPlacementProperty or undefined (abstract)
ramdiskId

SpotFleetResource.SpotFleetLaunchSpecificationProperty.RamdiskId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-ramdiskid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
securityGroups

SpotFleetResource.SpotFleetLaunchSpecificationProperty.SecurityGroups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-securitygroups

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or GroupIdentifierProperty)[] or undefined (abstract)
spotPrice

SpotFleetResource.SpotFleetLaunchSpecificationProperty.SpotPrice http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-spotprice

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
subnetId

SpotFleetResource.SpotFleetLaunchSpecificationProperty.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-subnetid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
tagSpecifications

SpotFleetResource.SpotFleetLaunchSpecificationProperty.TagSpecifications http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-tagspecifications

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or SpotFleetTagSpecificationProperty)[] or undefined (abstract)
userData

SpotFleetResource.SpotFleetLaunchSpecificationProperty.UserData http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-userdata

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
weightedCapacity

SpotFleetResource.SpotFleetLaunchSpecificationProperty.WeightedCapacity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-weightedcapacity

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
class SpotFleetMonitoringProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.SpotFleetMonitoringProperty;
// cloudformation.SpotFleetResource.SpotFleetMonitoringProperty is an interface
import { cloudformation.SpotFleetResource.SpotFleetMonitoringProperty } from '@aws-cdk/aws-ec2';
enabled

SpotFleetResource.SpotFleetMonitoringProperty.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-monitoring.html#cfn-ec2-spotfleet-spotfleetmonitoring-enabled

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
class SpotFleetRequestConfigDataProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.SpotFleetRequestConfigDataProperty;
// cloudformation.SpotFleetResource.SpotFleetRequestConfigDataProperty is an interface
import { cloudformation.SpotFleetResource.SpotFleetRequestConfigDataProperty } from '@aws-cdk/aws-ec2';
iamFleetRole

SpotFleetResource.SpotFleetRequestConfigDataProperty.IamFleetRole http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-iamfleetrole

Type:string or @aws-cdk/cdk.Token (abstract)
targetCapacity

SpotFleetResource.SpotFleetRequestConfigDataProperty.TargetCapacity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-targetcapacity

Type:number or @aws-cdk/cdk.Token (abstract)
allocationStrategy

SpotFleetResource.SpotFleetRequestConfigDataProperty.AllocationStrategy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-allocationstrategy

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
excessCapacityTerminationPolicy

SpotFleetResource.SpotFleetRequestConfigDataProperty.ExcessCapacityTerminationPolicy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-excesscapacityterminationpolicy

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
instanceInterruptionBehavior

SpotFleetResource.SpotFleetRequestConfigDataProperty.InstanceInterruptionBehavior http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-instanceinterruptionbehavior

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
launchSpecifications

SpotFleetResource.SpotFleetRequestConfigDataProperty.LaunchSpecifications http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or SpotFleetLaunchSpecificationProperty)[] or undefined (abstract)
launchTemplateConfigs

SpotFleetResource.SpotFleetRequestConfigDataProperty.LaunchTemplateConfigs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-launchtemplateconfigs

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or LaunchTemplateConfigProperty)[] or undefined (abstract)
loadBalancersConfig

SpotFleetResource.SpotFleetRequestConfigDataProperty.LoadBalancersConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-loadbalancersconfig

Type:@aws-cdk/cdk.Token or LoadBalancersConfigProperty or undefined (abstract)
replaceUnhealthyInstances

SpotFleetResource.SpotFleetRequestConfigDataProperty.ReplaceUnhealthyInstances http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-replaceunhealthyinstances

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
spotPrice

SpotFleetResource.SpotFleetRequestConfigDataProperty.SpotPrice http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-spotprice

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
terminateInstancesWithExpiration

SpotFleetResource.SpotFleetRequestConfigDataProperty.TerminateInstancesWithExpiration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-terminateinstanceswithexpiration

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
type

SpotFleetResource.SpotFleetRequestConfigDataProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-type

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
validFrom

SpotFleetResource.SpotFleetRequestConfigDataProperty.ValidFrom http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-validfrom

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
validUntil

SpotFleetResource.SpotFleetRequestConfigDataProperty.ValidUntil http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-validuntil

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
class SpotFleetTagSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.SpotFleetTagSpecificationProperty;
// cloudformation.SpotFleetResource.SpotFleetTagSpecificationProperty is an interface
import { cloudformation.SpotFleetResource.SpotFleetTagSpecificationProperty } from '@aws-cdk/aws-ec2';
resourceType

SpotFleetResource.SpotFleetTagSpecificationProperty.ResourceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-tagspecifications.html#cfn-ec2-spotfleet-spotfleettagspecification-resourcetype

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
class SpotPlacementProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.SpotPlacementProperty;
// cloudformation.SpotFleetResource.SpotPlacementProperty is an interface
import { cloudformation.SpotFleetResource.SpotPlacementProperty } from '@aws-cdk/aws-ec2';
availabilityZone

SpotFleetResource.SpotPlacementProperty.AvailabilityZone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-placement.html#cfn-ec2-spotfleet-spotplacement-availabilityzone

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
groupName

SpotFleetResource.SpotPlacementProperty.GroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-placement.html#cfn-ec2-spotfleet-spotplacement-groupname

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
tenancy

SpotFleetResource.SpotPlacementProperty.Tenancy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-placement.html#cfn-ec2-spotfleet-spotplacement-tenancy

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
class TargetGroupProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.TargetGroupProperty;
// cloudformation.SpotFleetResource.TargetGroupProperty is an interface
import { cloudformation.SpotFleetResource.TargetGroupProperty } from '@aws-cdk/aws-ec2';
arn

SpotFleetResource.TargetGroupProperty.Arn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-targetgroup.html#cfn-ec2-spotfleet-targetgroup-arn

Type:string or @aws-cdk/cdk.Token (abstract)
class TargetGroupsConfigProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.TargetGroupsConfigProperty;
// cloudformation.SpotFleetResource.TargetGroupsConfigProperty is an interface
import { cloudformation.SpotFleetResource.TargetGroupsConfigProperty } from '@aws-cdk/aws-ec2';
targetGroups

SpotFleetResource.TargetGroupsConfigProperty.TargetGroups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-targetgroupsconfig.html#cfn-ec2-spotfleet-targetgroupsconfig-targetgroups

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or TargetGroupProperty)[] (abstract)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

SpotFleetResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.SpotFleetResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResourceProps;
// cloudformation.SpotFleetResourceProps is an interface
import { cloudformation.SpotFleetResourceProps } from '@aws-cdk/aws-ec2';
spotFleetRequestConfigData

AWS::EC2::SpotFleet.SpotFleetRequestConfigData http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-spotfleet.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata

Type:@aws-cdk/cdk.Token or SpotFleetRequestConfigDataProperty (abstract)

SubnetCidrBlockResource

class @aws-cdk/aws-ec2.cloudformation.SubnetCidrBlockResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SubnetCidrBlockResource;
const { cloudformation.SubnetCidrBlockResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.SubnetCidrBlockResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this SubnetCidrBlockResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (SubnetCidrBlockResourceProps) – the properties of this SubnetCidrBlockResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:SubnetCidrBlockResourceProps (readonly)
subnetCidrBlockId
Type:string (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

SubnetCidrBlockResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.SubnetCidrBlockResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SubnetCidrBlockResourceProps;
// cloudformation.SubnetCidrBlockResourceProps is an interface
import { cloudformation.SubnetCidrBlockResourceProps } from '@aws-cdk/aws-ec2';
ipv6CidrBlock

AWS::EC2::SubnetCidrBlock.Ipv6CidrBlock http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#cfn-ec2-subnetcidrblock-ipv6cidrblock

Type:string or @aws-cdk/cdk.Token (abstract)
subnetId

AWS::EC2::SubnetCidrBlock.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#cfn-ec2-subnetcidrblock-subnetid

Type:string or @aws-cdk/cdk.Token (abstract)

SubnetNetworkAclAssociationResource

class @aws-cdk/aws-ec2.cloudformation.SubnetNetworkAclAssociationResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SubnetNetworkAclAssociationResource;
const { cloudformation.SubnetNetworkAclAssociationResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.SubnetNetworkAclAssociationResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:SubnetNetworkAclAssociationResourceProps (readonly)
subnetNetworkAclAssociationAssociationId
Type:string (readonly)
subnetNetworkAclAssociationName
Type:string (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

SubnetNetworkAclAssociationResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.SubnetNetworkAclAssociationResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SubnetNetworkAclAssociationResourceProps;
// cloudformation.SubnetNetworkAclAssociationResourceProps is an interface
import { cloudformation.SubnetNetworkAclAssociationResourceProps } from '@aws-cdk/aws-ec2';
networkAclId

AWS::EC2::SubnetNetworkAclAssociation.NetworkAclId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet-network-acl-assoc.html#cfn-ec2-subnetnetworkaclassociation-networkaclid

Type:string or @aws-cdk/cdk.Token (abstract)
subnetId

AWS::EC2::SubnetNetworkAclAssociation.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet-network-acl-assoc.html#cfn-ec2-subnetnetworkaclassociation-associationid

Type:string or @aws-cdk/cdk.Token (abstract)

SubnetResource

class @aws-cdk/aws-ec2.cloudformation.SubnetResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SubnetResource;
const { cloudformation.SubnetResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.SubnetResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this SubnetResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (SubnetResourceProps) – the properties of this SubnetResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:SubnetResourceProps (readonly)
subnetAvailabilityZone
Type:string (readonly)
subnetId
Type:string (readonly)
subnetIpv6CidrBlocks
Type:SubnetIpv6CidrBlocks (readonly)
subnetNetworkAclAssociationId
Type:string (readonly)
subnetVpcId
Type:string (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

SubnetResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.SubnetResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SubnetResourceProps;
// cloudformation.SubnetResourceProps is an interface
import { cloudformation.SubnetResourceProps } from '@aws-cdk/aws-ec2';
cidrBlock

AWS::EC2::Subnet.CidrBlock http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-cidrblock

Type:string or @aws-cdk/cdk.Token (abstract)
vpcId

AWS::EC2::Subnet.VpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-awsec2subnet-prop-vpcid

Type:string or @aws-cdk/cdk.Token (abstract)
assignIpv6AddressOnCreation

AWS::EC2::Subnet.AssignIpv6AddressOnCreation http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-assignipv6addressoncreation

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
availabilityZone

AWS::EC2::Subnet.AvailabilityZone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-availabilityzone

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
ipv6CidrBlock

AWS::EC2::Subnet.Ipv6CidrBlock http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv6cidrblock

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
mapPublicIpOnLaunch

AWS::EC2::Subnet.MapPublicIpOnLaunch http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-mappubliciponlaunch

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
tags

AWS::EC2::Subnet.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.Tag)[] or undefined (abstract)

SubnetRouteTableAssociationResource

class @aws-cdk/aws-ec2.cloudformation.SubnetRouteTableAssociationResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SubnetRouteTableAssociationResource;
const { cloudformation.SubnetRouteTableAssociationResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.SubnetRouteTableAssociationResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:SubnetRouteTableAssociationResourceProps (readonly)
subnetRouteTableAssociationName
Type:string (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

SubnetRouteTableAssociationResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.SubnetRouteTableAssociationResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SubnetRouteTableAssociationResourceProps;
// cloudformation.SubnetRouteTableAssociationResourceProps is an interface
import { cloudformation.SubnetRouteTableAssociationResourceProps } from '@aws-cdk/aws-ec2';
routeTableId

AWS::EC2::SubnetRouteTableAssociation.RouteTableId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet-route-table-assoc.html#cfn-ec2-subnetroutetableassociation-routetableid

Type:string or @aws-cdk/cdk.Token (abstract)
subnetId

AWS::EC2::SubnetRouteTableAssociation.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet-route-table-assoc.html#cfn-ec2-subnetroutetableassociation-subnetid

Type:string or @aws-cdk/cdk.Token (abstract)

TrunkInterfaceAssociationResource

class @aws-cdk/aws-ec2.cloudformation.TrunkInterfaceAssociationResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.TrunkInterfaceAssociationResource;
const { cloudformation.TrunkInterfaceAssociationResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.TrunkInterfaceAssociationResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:TrunkInterfaceAssociationResourceProps (readonly)
trunkInterfaceAssociationId
Type:string (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

TrunkInterfaceAssociationResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.TrunkInterfaceAssociationResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.TrunkInterfaceAssociationResourceProps;
// cloudformation.TrunkInterfaceAssociationResourceProps is an interface
import { cloudformation.TrunkInterfaceAssociationResourceProps } from '@aws-cdk/aws-ec2';
branchInterfaceId

AWS::EC2::TrunkInterfaceAssociation.BranchInterfaceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trunkinterfaceassociation.html#cfn-ec2-trunkinterfaceassociation-branchinterfaceid

Type:string or @aws-cdk/cdk.Token (abstract)
trunkInterfaceId

AWS::EC2::TrunkInterfaceAssociation.TrunkInterfaceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trunkinterfaceassociation.html#cfn-ec2-trunkinterfaceassociation-trunkinterfaceid

Type:string or @aws-cdk/cdk.Token (abstract)
greKey

AWS::EC2::TrunkInterfaceAssociation.GREKey http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trunkinterfaceassociation.html#cfn-ec2-trunkinterfaceassociation-grekey

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
vlanId

AWS::EC2::TrunkInterfaceAssociation.VLANId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trunkinterfaceassociation.html#cfn-ec2-trunkinterfaceassociation-vlanid

Type:number or @aws-cdk/cdk.Token or undefined (abstract)

VPCCidrBlockResource

class @aws-cdk/aws-ec2.cloudformation.VPCCidrBlockResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCCidrBlockResource;
const { cloudformation.VPCCidrBlockResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VPCCidrBlockResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this VPCCidrBlockResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (VPCCidrBlockResourceProps) – the properties of this VPCCidrBlockResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:VPCCidrBlockResourceProps (readonly)
vpcCidrBlockId
Type:string (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

VPCCidrBlockResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.VPCCidrBlockResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCCidrBlockResourceProps;
// cloudformation.VPCCidrBlockResourceProps is an interface
import { cloudformation.VPCCidrBlockResourceProps } from '@aws-cdk/aws-ec2';
vpcId

AWS::EC2::VPCCidrBlock.VpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-vpcid

Type:string or @aws-cdk/cdk.Token (abstract)
amazonProvidedIpv6CidrBlock

AWS::EC2::VPCCidrBlock.AmazonProvidedIpv6CidrBlock http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-amazonprovidedipv6cidrblock

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
cidrBlock

AWS::EC2::VPCCidrBlock.CidrBlock http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-cidrblock

Type:string or @aws-cdk/cdk.Token or undefined (abstract)

VPCDHCPOptionsAssociationResource

class @aws-cdk/aws-ec2.cloudformation.VPCDHCPOptionsAssociationResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCDHCPOptionsAssociationResource;
const { cloudformation.VPCDHCPOptionsAssociationResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VPCDHCPOptionsAssociationResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:VPCDHCPOptionsAssociationResourceProps (readonly)
vpcdhcpOptionsAssociationName
Type:string (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

VPCDHCPOptionsAssociationResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.VPCDHCPOptionsAssociationResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCDHCPOptionsAssociationResourceProps;
// cloudformation.VPCDHCPOptionsAssociationResourceProps is an interface
import { cloudformation.VPCDHCPOptionsAssociationResourceProps } from '@aws-cdk/aws-ec2';
dhcpOptionsId

AWS::EC2::VPCDHCPOptionsAssociation.DhcpOptionsId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-dhcp-options-assoc.html#cfn-ec2-vpcdhcpoptionsassociation-dhcpoptionsid

Type:string or @aws-cdk/cdk.Token (abstract)
vpcId

AWS::EC2::VPCDHCPOptionsAssociation.VpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-dhcp-options-assoc.html#cfn-ec2-vpcdhcpoptionsassociation-vpcid

Type:string or @aws-cdk/cdk.Token (abstract)

VPCEndpointConnectionNotificationResource

class @aws-cdk/aws-ec2.cloudformation.VPCEndpointConnectionNotificationResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCEndpointConnectionNotificationResource;
const { cloudformation.VPCEndpointConnectionNotificationResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VPCEndpointConnectionNotificationResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:VPCEndpointConnectionNotificationResourceProps (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

VPCEndpointConnectionNotificationResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.VPCEndpointConnectionNotificationResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCEndpointConnectionNotificationResourceProps;
// cloudformation.VPCEndpointConnectionNotificationResourceProps is an interface
import { cloudformation.VPCEndpointConnectionNotificationResourceProps } from '@aws-cdk/aws-ec2';
connectionEvents

AWS::EC2::VPCEndpointConnectionNotification.ConnectionEvents http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html#cfn-ec2-vpcendpointconnectionnotification-connectionevents

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (abstract)
connectionNotificationArn

AWS::EC2::VPCEndpointConnectionNotification.ConnectionNotificationArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html#cfn-ec2-vpcendpointconnectionnotification-connectionnotificationarn

Type:string or @aws-cdk/cdk.Token (abstract)
serviceId

AWS::EC2::VPCEndpointConnectionNotification.ServiceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html#cfn-ec2-vpcendpointconnectionnotification-serviceid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
vpcEndpointId

AWS::EC2::VPCEndpointConnectionNotification.VPCEndpointId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html#cfn-ec2-vpcendpointconnectionnotification-vpcendpointid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)

VPCEndpointResource

class @aws-cdk/aws-ec2.cloudformation.VPCEndpointResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCEndpointResource;
const { cloudformation.VPCEndpointResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VPCEndpointResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this VPCEndpointResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (VPCEndpointResourceProps) – the properties of this VPCEndpointResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:VPCEndpointResourceProps (readonly)
vpcEndpointCreationTimestamp
Type:string (readonly)
vpcEndpointDnsEntries
Type:VPCEndpointDnsEntries (readonly)
vpcEndpointId
Type:string (readonly)
vpcEndpointNetworkInterfaceIds
Type:VPCEndpointNetworkInterfaceIds (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

VPCEndpointResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.VPCEndpointResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCEndpointResourceProps;
// cloudformation.VPCEndpointResourceProps is an interface
import { cloudformation.VPCEndpointResourceProps } from '@aws-cdk/aws-ec2';
serviceName

AWS::EC2::VPCEndpoint.ServiceName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-servicename

Type:string or @aws-cdk/cdk.Token (abstract)
vpcId

AWS::EC2::VPCEndpoint.VpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-vpcid

Type:string or @aws-cdk/cdk.Token (abstract)
policyDocument

AWS::EC2::VPCEndpoint.PolicyDocument http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-policydocument

Type:json or @aws-cdk/cdk.Token or undefined (abstract)
privateDnsEnabled

AWS::EC2::VPCEndpoint.PrivateDnsEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-privatednsenabled

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
routeTableIds

AWS::EC2::VPCEndpoint.RouteTableIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-routetableids

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] or undefined (abstract)
securityGroupIds

AWS::EC2::VPCEndpoint.SecurityGroupIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-securitygroupids

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] or undefined (abstract)
subnetIds

AWS::EC2::VPCEndpoint.SubnetIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-subnetids

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] or undefined (abstract)
vpcEndpointType

AWS::EC2::VPCEndpoint.VpcEndpointType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-vpcendpointtype

Type:string or @aws-cdk/cdk.Token or undefined (abstract)

VPCEndpointServicePermissionsResource

class @aws-cdk/aws-ec2.cloudformation.VPCEndpointServicePermissionsResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCEndpointServicePermissionsResource;
const { cloudformation.VPCEndpointServicePermissionsResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VPCEndpointServicePermissionsResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:VPCEndpointServicePermissionsResourceProps (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

VPCEndpointServicePermissionsResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.VPCEndpointServicePermissionsResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCEndpointServicePermissionsResourceProps;
// cloudformation.VPCEndpointServicePermissionsResourceProps is an interface
import { cloudformation.VPCEndpointServicePermissionsResourceProps } from '@aws-cdk/aws-ec2';
serviceId

AWS::EC2::VPCEndpointServicePermissions.ServiceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservicepermissions.html#cfn-ec2-vpcendpointservicepermissions-serviceid

Type:string or @aws-cdk/cdk.Token (abstract)
allowedPrincipals

AWS::EC2::VPCEndpointServicePermissions.AllowedPrincipals http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservicepermissions.html#cfn-ec2-vpcendpointservicepermissions-allowedprincipals

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] or undefined (abstract)

VPCGatewayAttachmentResource

class @aws-cdk/aws-ec2.cloudformation.VPCGatewayAttachmentResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCGatewayAttachmentResource;
const { cloudformation.VPCGatewayAttachmentResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VPCGatewayAttachmentResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:VPCGatewayAttachmentResourceProps (readonly)
vpcGatewayAttachmentName
Type:string (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

VPCGatewayAttachmentResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.VPCGatewayAttachmentResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCGatewayAttachmentResourceProps;
// cloudformation.VPCGatewayAttachmentResourceProps is an interface
import { cloudformation.VPCGatewayAttachmentResourceProps } from '@aws-cdk/aws-ec2';
vpcId

AWS::EC2::VPCGatewayAttachment.VpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html#cfn-ec2-vpcgatewayattachment-vpcid

Type:string or @aws-cdk/cdk.Token (abstract)
internetGatewayId

AWS::EC2::VPCGatewayAttachment.InternetGatewayId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html#cfn-ec2-vpcgatewayattachment-internetgatewayid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
vpnGatewayId

AWS::EC2::VPCGatewayAttachment.VpnGatewayId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html#cfn-ec2-vpcgatewayattachment-vpngatewayid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)

VPCPeeringConnectionResource

class @aws-cdk/aws-ec2.cloudformation.VPCPeeringConnectionResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCPeeringConnectionResource;
const { cloudformation.VPCPeeringConnectionResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VPCPeeringConnectionResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:VPCPeeringConnectionResourceProps (readonly)
vpcPeeringConnectionName
Type:string (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

VPCPeeringConnectionResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.VPCPeeringConnectionResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCPeeringConnectionResourceProps;
// cloudformation.VPCPeeringConnectionResourceProps is an interface
import { cloudformation.VPCPeeringConnectionResourceProps } from '@aws-cdk/aws-ec2';
peerVpcId

AWS::EC2::VPCPeeringConnection.PeerVpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peervpcid

Type:string or @aws-cdk/cdk.Token (abstract)
vpcId

AWS::EC2::VPCPeeringConnection.VpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-vpcid

Type:string or @aws-cdk/cdk.Token (abstract)
peerOwnerId

AWS::EC2::VPCPeeringConnection.PeerOwnerId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peerownerid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
peerRegion

AWS::EC2::VPCPeeringConnection.PeerRegion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peerregion

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
peerRoleArn

AWS::EC2::VPCPeeringConnection.PeerRoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peerrolearn

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
tags

AWS::EC2::VPCPeeringConnection.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.Tag)[] or undefined (abstract)

VPCResource

class @aws-cdk/aws-ec2.cloudformation.VPCResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCResource;
const { cloudformation.VPCResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VPCResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this VPCResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (VPCResourceProps) – the properties of this VPCResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:VPCResourceProps (readonly)
vpcCidrBlock
Type:string (readonly)
vpcCidrBlockAssociations
Type:VPCCidrBlockAssociations (readonly)
vpcDefaultNetworkAcl
Type:string (readonly)
vpcDefaultSecurityGroup
Type:string (readonly)
vpcId
Type:string (readonly)
vpcIpv6CidrBlocks
Type:VPCIpv6CidrBlocks (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

VPCResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.VPCResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCResourceProps;
// cloudformation.VPCResourceProps is an interface
import { cloudformation.VPCResourceProps } from '@aws-cdk/aws-ec2';
cidrBlock

AWS::EC2::VPC.CidrBlock http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-aws-ec2-vpc-cidrblock

Type:string or @aws-cdk/cdk.Token (abstract)
enableDnsHostnames

AWS::EC2::VPC.EnableDnsHostnames http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-aws-ec2-vpc-EnableDnsHostnames

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
enableDnsSupport

AWS::EC2::VPC.EnableDnsSupport http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-aws-ec2-vpc-EnableDnsSupport

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
instanceTenancy

AWS::EC2::VPC.InstanceTenancy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-aws-ec2-vpc-instancetenancy

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
tags

AWS::EC2::VPC.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-aws-ec2-vpc-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.Tag)[] or undefined (abstract)

VPNConnectionResource

class @aws-cdk/aws-ec2.cloudformation.VPNConnectionResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPNConnectionResource;
const { cloudformation.VPNConnectionResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VPNConnectionResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this VPNConnectionResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (VPNConnectionResourceProps) – the properties of this VPNConnectionResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:VPNConnectionResourceProps (readonly)
vpnConnectionName
Type:string (readonly)
class VpnTunnelOptionsSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPNConnectionResource.VpnTunnelOptionsSpecificationProperty;
// cloudformation.VPNConnectionResource.VpnTunnelOptionsSpecificationProperty is an interface
import { cloudformation.VPNConnectionResource.VpnTunnelOptionsSpecificationProperty } from '@aws-cdk/aws-ec2';
preSharedKey

VPNConnectionResource.VpnTunnelOptionsSpecificationProperty.PreSharedKey http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-presharedkey

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
tunnelInsideCidr

VPNConnectionResource.VpnTunnelOptionsSpecificationProperty.TunnelInsideCidr http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-tunnelinsidecidr

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

VPNConnectionResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.VPNConnectionResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPNConnectionResourceProps;
// cloudformation.VPNConnectionResourceProps is an interface
import { cloudformation.VPNConnectionResourceProps } from '@aws-cdk/aws-ec2';
customerGatewayId

AWS::EC2::VPNConnection.CustomerGatewayId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html#cfn-ec2-vpnconnection-customergatewayid

Type:string or @aws-cdk/cdk.Token (abstract)
type

AWS::EC2::VPNConnection.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html#cfn-ec2-vpnconnection-type

Type:string or @aws-cdk/cdk.Token (abstract)
vpnGatewayId

AWS::EC2::VPNConnection.VpnGatewayId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html#cfn-ec2-vpnconnection-vpngatewayid

Type:string or @aws-cdk/cdk.Token (abstract)
staticRoutesOnly

AWS::EC2::VPNConnection.StaticRoutesOnly http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html#cfn-ec2-vpnconnection-StaticRoutesOnly

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
tags

AWS::EC2::VPNConnection.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html#cfn-ec2-vpnconnection-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.Tag)[] or undefined (abstract)
vpnTunnelOptionsSpecifications

AWS::EC2::VPNConnection.VpnTunnelOptionsSpecifications http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html#cfn-ec2-vpnconnection-vpntunneloptionsspecifications

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or VpnTunnelOptionsSpecificationProperty)[] or undefined (abstract)

VPNConnectionRouteResource

class @aws-cdk/aws-ec2.cloudformation.VPNConnectionRouteResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPNConnectionRouteResource;
const { cloudformation.VPNConnectionRouteResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VPNConnectionRouteResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this VPNConnectionRouteResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (VPNConnectionRouteResourceProps) – the properties of this VPNConnectionRouteResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:VPNConnectionRouteResourceProps (readonly)
vpnConnectionRouteName
Type:string (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

VPNConnectionRouteResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.VPNConnectionRouteResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPNConnectionRouteResourceProps;
// cloudformation.VPNConnectionRouteResourceProps is an interface
import { cloudformation.VPNConnectionRouteResourceProps } from '@aws-cdk/aws-ec2';
destinationCidrBlock

AWS::EC2::VPNConnectionRoute.DestinationCidrBlock http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection-route.html#cfn-ec2-vpnconnectionroute-cidrblock

Type:string or @aws-cdk/cdk.Token (abstract)
vpnConnectionId

AWS::EC2::VPNConnectionRoute.VpnConnectionId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection-route.html#cfn-ec2-vpnconnectionroute-connectionid

Type:string or @aws-cdk/cdk.Token (abstract)

VPNGatewayResource

class @aws-cdk/aws-ec2.cloudformation.VPNGatewayResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPNGatewayResource;
const { cloudformation.VPNGatewayResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VPNGatewayResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this VPNGatewayResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (VPNGatewayResourceProps) – the properties of this VPNGatewayResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:VPNGatewayResourceProps (readonly)
vpnGatewayName
Type:string (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

VPNGatewayResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.VPNGatewayResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPNGatewayResourceProps;
// cloudformation.VPNGatewayResourceProps is an interface
import { cloudformation.VPNGatewayResourceProps } from '@aws-cdk/aws-ec2';
type

AWS::EC2::VPNGateway.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-gateway.html#cfn-ec2-vpngateway-type

Type:string or @aws-cdk/cdk.Token (abstract)
amazonSideAsn

AWS::EC2::VPNGateway.AmazonSideAsn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-gateway.html#cfn-ec2-vpngateway-amazonsideasn

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
tags

AWS::EC2::VPNGateway.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-gateway.html#cfn-ec2-vpngateway-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.Tag)[] or undefined (abstract)

VPNGatewayRoutePropagationResource

class @aws-cdk/aws-ec2.cloudformation.VPNGatewayRoutePropagationResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPNGatewayRoutePropagationResource;
const { cloudformation.VPNGatewayRoutePropagationResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VPNGatewayRoutePropagationResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:VPNGatewayRoutePropagationResourceProps (readonly)
vpnGatewayRoutePropagationName
Type:string (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

VPNGatewayRoutePropagationResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.VPNGatewayRoutePropagationResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPNGatewayRoutePropagationResourceProps;
// cloudformation.VPNGatewayRoutePropagationResourceProps is an interface
import { cloudformation.VPNGatewayRoutePropagationResourceProps } from '@aws-cdk/aws-ec2';
routeTableIds

AWS::EC2::VPNGatewayRoutePropagation.RouteTableIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-gatewayrouteprop.html#cfn-ec2-vpngatewayrouteprop-routetableids

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (abstract)
vpnGatewayId

AWS::EC2::VPNGatewayRoutePropagation.VpnGatewayId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-gatewayrouteprop.html#cfn-ec2-vpngatewayrouteprop-vpngatewayid

Type:string or @aws-cdk/cdk.Token (abstract)

VolumeAttachmentResource

class @aws-cdk/aws-ec2.cloudformation.VolumeAttachmentResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VolumeAttachmentResource;
const { cloudformation.VolumeAttachmentResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VolumeAttachmentResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this VolumeAttachmentResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (VolumeAttachmentResourceProps) – the properties of this VolumeAttachmentResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:VolumeAttachmentResourceProps (readonly)
volumeAttachmentId
Type:string (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

VolumeAttachmentResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.VolumeAttachmentResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VolumeAttachmentResourceProps;
// cloudformation.VolumeAttachmentResourceProps is an interface
import { cloudformation.VolumeAttachmentResourceProps } from '@aws-cdk/aws-ec2';
device

AWS::EC2::VolumeAttachment.Device http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volumeattachment.html#cfn-ec2-ebs-volumeattachment-device

Type:string or @aws-cdk/cdk.Token (abstract)
instanceId

AWS::EC2::VolumeAttachment.InstanceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volumeattachment.html#cfn-ec2-ebs-volumeattachment-instanceid

Type:string or @aws-cdk/cdk.Token (abstract)
volumeId

AWS::EC2::VolumeAttachment.VolumeId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volumeattachment.html#cfn-ec2-ebs-volumeattachment-volumeid

Type:string or @aws-cdk/cdk.Token (abstract)

VolumeResource

class @aws-cdk/aws-ec2.cloudformation.VolumeResource(parent, name, properties)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VolumeResource;
const { cloudformation.VolumeResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VolumeResource } from '@aws-cdk/aws-ec2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
  • parent (@aws-cdk/cdk.Construct) – the cdk.Construct this VolumeResource is a part of
  • name (string) – the name of the resource in the cdk.Construct tree
  • properties (VolumeResourceProps) – the properties of this VolumeResource
renderProperties([properties]) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any or undefined) –
Return type:string => (any or undefined)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:VolumeResourceProps (readonly)
volumeId
Type:string (readonly)
addChild(child, childName)

Inherited from @aws-cdk/cdk.Construct

Adds a child construct to this node.

Protected method

Parameters:
Returns:

The resolved path part name of the child

addError(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds an { error: <message> } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

Parameters:message (string) – The error message.
Return type:@aws-cdk/cdk.Construct
addInfo(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { “aws:cdk:info”: <message> } metadata entry to this construct. The toolkit will display the info message when apps are synthesized.

Parameters:message (string) – The info message.
Return type:@aws-cdk/cdk.Construct
addMetadata(type[, data[, from]]) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a metadata entry to this construct. Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.

Parameters:
  • type (string) – a string denoting the type of metadata
  • data (any or undefined) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
  • from (any or undefined) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:

@aws-cdk/cdk.Construct

addWarning(message) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Adds a { warning: <message> } metadata entry to this construct. The toolkit will display the warning when an app is synthesized, or fail if run in –strict mode.

Parameters:message (string) – The warning message.
Return type:@aws-cdk/cdk.Construct
ancestors([upTo]) → @aws-cdk/cdk.Construct[]

Inherited from @aws-cdk/cdk.Construct

Return the ancestors (including self) of this Construct up until and excluding the indicated component

Parameters:upTo (@aws-cdk/cdk.Construct or undefined) –
Return type:@aws-cdk/cdk.Construct[]
findChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path Throws an exception if the descendant is not found.

Parameters:path (string) –
Returns:Child with the given path.
Return type:@aws-cdk/cdk.Construct
getContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieves a value from tree context. Context is usually initialized at the root, but can be overridden at any point in the tree.

Parameters:key (string) – The context key
Returns:The context value or undefined
Return type:any or undefined
lock()

Inherited from @aws-cdk/cdk.Construct

Locks this construct from allowing more children to be added. After this call, no more children can be added to this construct or to any children.

Protected method

requireContext(key) → any

Inherited from @aws-cdk/cdk.Construct

Retrieve a value from tree-global context It is an error if the context object is not available.

Parameters:key (string) –
Return type:any or undefined
required(props, name) → any

Inherited from @aws-cdk/cdk.Construct

Throws if the props bag doesn’t include the property name. In the future we can add some type-checking here, maybe even auto-generate during compilation.

Protected method

Parameters:
  • props (any or undefined) – The props bag.
  • name (string) – The name of the required property.
Return type:

any or undefined

setContext(key[, value])

Inherited from @aws-cdk/cdk.Construct

This can be used to set contextual values. Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.

Parameters:
  • key (string) – The context key
  • value (any or undefined) – The context value
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
toTreeString([depth]) → string

Inherited from @aws-cdk/cdk.Construct

Returns a string with a tree representation of this construct and it’s children.

Parameters:depth (number or undefined) –
Return type:string
tryFindChild(path) → @aws-cdk/cdk.Construct

Inherited from @aws-cdk/cdk.Construct

Return a descendant by path, or undefined

Parameters:path (string) –
Returns:a child by path or undefined if not found.
Return type:@aws-cdk/cdk.Construct or undefined
unlock()

Inherited from @aws-cdk/cdk.Construct

Unlocks this costruct and allows mutations (adding children).

Protected method

validate() → string[]

Inherited from @aws-cdk/cdk.Construct

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
validateTree() → @aws-cdk/cdk.ValidationError[]

Inherited from @aws-cdk/cdk.Construct

Invokes ‘validate’ on all child constructs and then on this construct (depth-first).

Returns:A list of validation errors. If the list is empty, all constructs are valid.
Return type:@aws-cdk/cdk.ValidationError[]
children

Inherited from @aws-cdk/cdk.Construct

All direct children of this construct.

Type:@aws-cdk/cdk.Construct[] (readonly)
id

Inherited from @aws-cdk/cdk.Construct

The local id of the construct. This id is unique amongst its siblings. To obtain a tree-global unique id for this construct, use uniqueId.

Type:string (readonly)
locked

Inherited from @aws-cdk/cdk.Construct

Returns true if this construct or any of it’s parent constructs are locked.

Protected property

Type:boolean (readonly)
metadata

Inherited from @aws-cdk/cdk.Construct

An array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.

Type:@aws-cdk/cdk.MetadataEntry[] (readonly)
path

Inherited from @aws-cdk/cdk.Construct

The full path of this construct in the tree. Components are separated by ‘/’.

Type:string (readonly)
uniqueId

Inherited from @aws-cdk/cdk.Construct

A tree-global unique alphanumeric identifier for this construct. Includes all components of the tree.

Type:string (readonly)
parent

Inherited from @aws-cdk/cdk.Construct

Returns the parent of this node or undefined if this is a root node.

Type:@aws-cdk/cdk.Construct or undefined (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependency(*other)

Inherited from @aws-cdk/cdk.Resource

Adds a dependency on another resource.

Parameters:*other (@aws-cdk/cdk.IDependable) – The other resource.
addOverride(path[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any or undefined) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath[, value])

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property. Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any or undefined) – The value
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CloudFormationToken
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties. This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any or undefined (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides. During synthesis, the method “renderProperties(this.overrides)” is called with this object, and merged on top of the output of “renderProperties(this.properties)”. Derived classes should expose a strongly-typed version of this object as a public property called propertyOverrides.

Protected property

Type:any or undefined (readonly)
creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
dependencyElements

Inherited from @aws-cdk/cdk.StackElement

Returns the set of all stack elements (resources, parameters, conditions) that should be added when a resource “depends on” this construct.

Type:@aws-cdk/cdk.IDependable[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

VolumeResourceProps (interface)

class @aws-cdk/aws-ec2.cloudformation.VolumeResourceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VolumeResourceProps;
// cloudformation.VolumeResourceProps is an interface
import { cloudformation.VolumeResourceProps } from '@aws-cdk/aws-ec2';
availabilityZone

AWS::EC2::Volume.AvailabilityZone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-availabilityzone

Type:string or @aws-cdk/cdk.Token (abstract)
autoEnableIo

AWS::EC2::Volume.AutoEnableIO http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-autoenableio

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
encrypted

AWS::EC2::Volume.Encrypted http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-encrypted

Type:boolean or @aws-cdk/cdk.Token or undefined (abstract)
iops

AWS::EC2::Volume.Iops http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-iops

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
kmsKeyId

AWS::EC2::Volume.KmsKeyId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-kmskeyid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
size

AWS::EC2::Volume.Size http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-size

Type:number or @aws-cdk/cdk.Token or undefined (abstract)
snapshotId

AWS::EC2::Volume.SnapshotId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-snapshotid

Type:string or @aws-cdk/cdk.Token or undefined (abstract)
tags

AWS::EC2::Volume.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.Tag)[] or undefined (abstract)
volumeType

AWS::EC2::Volume.VolumeType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-volumetype

Type:string or @aws-cdk/cdk.Token or undefined (abstract)